Game Development Community

Plan for Sam Bacsa

by Sam Bacsa · 09/16/2005 (9:05 am) · 10 comments

I don't mean for this to completely push my other .plan from the importance-ness, so please read that, too, if you get a chance.

Since I had to release an update to fix some issues with Windows 2000 systems not generating the hardware key correctly (and consequently causing an exception), I'm also releasing a feature that I wanted to save for the next delta... but here it is anyway.

First off, list of major changes:

- Fixed issue with machine code generation causing exceptions on certain Windows 2000 systems
- Fixed the method by which projects are opened to speed up loading time
- Fixed the fact that class properties weren't showing up in member completion (auto-complete)
- Added Snippeter

So, just to dive into Snippeter for a second:

Snippeter is a codeblock management system. It allows you to store code for re-use in a convenient, searchable interface which then writes to an XML file for easy modification or access outside of TorqueDev.

If you download the update using the update wizard, you should see the Snippeter docking panel on the right-hand side:
www.imgspace.net/go/I432ae93f88555.jpg

If you can't see it, go to Window->Show All Developer Tabs, and it should appear.

You can store codeblocks in three different ways:
- Right-click on the Snippeter treeview and click "Add New Snippet"
- Highlight any code in the code editor and click "Create Snippet"
- Right-click on the Snippeter treeview and click "Import Snippet"

(The latter method will be discussed in greater detail in a bit)

Regardless of which approach you take, you should have the following dialog appear:
www.imgspace.net/go/S432ae93fa3322.jpg

You can fill out all the fields here and edit your code snippet should you need to do so (you'll get a blank codebox if you didn't use method #2 or #3 above). Note that the codebox in the snippet window does not have autocomplete or any other enhancements. It simply syntax-highlights. The only fields that are requred are title, category, and the code.

The words you place in keywords will be used when searching, so desciptive words.

When you click Create (or Import via method #3), your snippet will appear in the Snippeter menu.
www.imgspace.net/go/W432ae93fb447b.jpg


You can now paste your code snippet in any active editor by double-clicking on the snippet in the list. You can copy the snippet's code to the clipboard by right-clicking and selecting "Copy Code to Clipboard".

The most powerful feature, however, is the "Copy Shortcut" feature. If you right-click on the snippet and select "Copy Shortcut", your snippet will be automatically uploaded to the TorqueDev Snippeter database and a URL will be placed into your clipboard. You can then pate this link to anyone, and they will receive all the information about your snippet (including the metadata details), plus a syntax-highlighted representation of your code.

Click the link below to see a sample codeblock:
http://www.torquedev.com/network/snippetter.php?op=showcode&id=1


If you want to import someone's snippet, complete with metadata, you can utilize the "Import Snippet" function in the right-click menu. Enter the snippet ID that is listed on the web page and it will be automatically imported.


Snippets are cached in the TorqueDev repository indefinitely so long as someone visits your snippet once every thirty days. If there is no activity on a snippet after 30 days it is cleared. A snippet can be re-uploaded easily by selecting "Copy Shortcut" again in the context menu. The system will recognize that the snippet was deleted and will upload a fresh copy.


This service is provided free of charge to all TorqueDev users. I sincerely hope that it is useful and fills some sort of niche.

Any questions, comments, or suggestions are welcome via the forums or e-mail. Bugs should go to the bug reports site.


PS - The maximum size of a code snippet is 20 KB to be able to utilize the Copy Shortcut feature.


The update is available through the update wizard application. You can grab a copy of TorqueDev here.

#1
09/16/2005 (9:26 am)
Wow, awesome work... hrm, I might have to update now... been holding off because I really don't want to have to re-download everything to get the registration to work.
#2
09/16/2005 (9:55 am)
I cant believe how fast you fixed the Win2K bug ;)

Amazing work Sam!
#3
09/16/2005 (9:58 am)
So awesome. I actually just started using a single file to hold a bunch of my code snippets... having this snippet feature will be awesome. I especially like the ingenuity of having a snippet database ^_^

Great work, as always :)
#4
09/16/2005 (10:09 am)
This is turning out to be an awsome tool for developing.
Thanks Sam.
#5
09/16/2005 (10:14 am)
omg, yes... the "new vertical tab group" was what I was looking for... dunno when you actually got it in there (and maybe it was always there but I just missed it). I work on a triple-monitor system so I can view more code / art / game simultaneously, and it was a royal pain not being able to view more than one horizontal group of tabs.

I actually finally downloaded the latest release and got it authorized. Took me three tries on TSE, though... dunno why because all of the files I was asked about were one's that I'd not changed significantly. Maybe you should state exactly what version you're comparing against on the authorization screen?

Thanks, Sam... you rock.
#6
09/16/2005 (10:27 am)
I had some problems with auth too, but an email in about it was answered insanely quickly and I had it up and running in no time. Great work on that and the new updates Sam!
#7
09/16/2005 (2:38 pm)
Thanks for the comments :)

@Tony: You can actually drag any of the tabs to dock on any side of the screen by dragging the tab with the icon. You can, of course, drag the whole tab group as well.

The TSE thing is a pain in the ass for me, because they run updates to it very frequently. I was toying with not using the HEAD version of the code, but most people will end up downloading that and forcing people to download another set of older code would be tedious. I guess I'll just have to stick to updating my auth files at least once every few days.

If anyone ever has any issues, please don't hesitate to contact me regarding the auth. I usually have my email client open when I'm working and it beeps as soon as I get mail in ... oh the joys of IMAP :)
#8
09/16/2005 (3:26 pm)
Oh I wanted to add that there are some exciting things that'll be coming to TorqueDev within the next few weeks.

Here are the two major features we'll be adding:

- Plugin architecture will give access to the complete list of in-project functions and objects, giving plugin developers a powerful tool in determining what's in the project and how to use it.

- The Intellicode (which is what I'm going to call it) system will scan the code for common syntax errors and notify the developer of such errors both before debugging and on demand.



A bunch of minor features such as a breakpoint browser and other misc utlilities will also be added.
#9
09/16/2005 (3:30 pm)
I dont have your tool, but the more I read about it, the more I want it, I think you have convinced me to get it. Awesome work Sam!
#10
10/01/2005 (9:53 pm)
Slickedit has something called "aliases" which is just a templating facility like snippeter, but it also has parameters that it will prompt you for. So I have an alias "functionx" that prompts me for function name, purpose, parameters, and return info, and it then fills in the parameters into some code like this.


//----------------------------------------------------------------------
// getIt
// purpose: get tha thang
// params: %p1, %p2
// returns: the thang (string)
function getIt ( %p1, %p2 )
{

}

Personally I would find this kind of parameterization more useful than the web-based sharing of snippeteer, altough that is kind of a cool idea.