Python map packaging script RC4

MovingTarget | 2008-01-23 21:20

[

points ]

(6 votes)

Blurb A Python packager that ensures proper directory structure

Detailed description

This is a little Python script I whipped up which
takes the name of the map you want to package, and
Sauerbraten's base directory, and makes a directory
structure with your map, cfg file, readme, and screenshot.
It then mashes the lot into a compressed .zip
archive, and deletes the original folders.

It *should* be cross-platform, because I use os (.path)
methods, but I've only tested it on Windows.

Simply run the script, follow instructions, and you will
have a compressed .zip archive with the name of your map
sitting in your current directory. So all you have to do is
post it on Quadropolis. No newbies getting their nodes
deleted, and no admins angry at bad directory structure!
We're all happy.

Windows users: There is an exe in there for you, so don't
panic if you don't have Python installed.

*UPDATE*: Added support for Blood Frontier, SVN version
*UPDATE TWO*: Added zip file support, cleaned up code a lot
*UPDATE THREE*: Added compression support, made exe for Windows users
*UPDATE FOUR*: [I think] I've fixed all MeatROme's tips (hope you can revise your rating!)
Added .exe for Windows users, attachment for linux users. README goes into more detail

Mod file setup.exe (1.32 MB)

Rating

points

(6 votes)

Attachment	Size
linux.zip	1.97 KB

Comments

MeatROme | 2008-01-23 23:42

I applaud you for the effort to make life easier on newcome Quadropolis users!

I just looked at the 3rd update you've posted - nice and simple script :)
May I suggest you use the new "Attachment" feature we've enabled for nodes - it'd be nice for non-Windows users to download only what they need (roughly 1.6KB) instead of the 2MB it's now. Decide yourself which you'd place at the top - I'd say probably Windows-Version (coz' it's users don't tend to look too far) and the minimalistic version as attachment ;-)

Anyway - I spotted some issues:

The README should go into more detail IMHO, like putting your script into /usr/local/bin for ready execution and calling it from inside the relevant games installation folder - then you could loose the query for the folder ... which I consider the biggest drawback (regarding ease-of-use) for it currently. On Windows the EXE should go somewhere inside $PATH (e.g. C:\Windows\ or somesuch) .. maybe making links on your desktop that set the right working directory would be sufficient ... as a last resort you might consider something like an INI-file where users can save the location of their games, so it'd be a one-time-only question!
You haven't actually made it work with either AssaultCube or the original Cube - their extensions are CGZ, not OGZ .. and for AssaultCube the directory structure is packages/maps not packages/base!
There's a bit of a confusion regarding screenshots - the JPG inside packages/base is used in Sauerbraten for displaying a shot during mapload - it's required to be of square-dimensions (width equals height (256x256)) ... but for quadropolis nodes you usually want a somewhat larger image as screenshot and one not bound to squareness, but rather something like 640x480. Either way such shots need to be prepared in advance; the README should probably elaborate some on that subject.

MovingTarget | 2008-01-30 15:13

Hey, thanks for the pointers! I *really* appreciate the detail of your feedback (instead of just 'omg horrible') so I can fix it.
I'll see what I can do!

~MovingTarget

MeatROme | 2008-02-10 17:24

Okay, then - hey thanks for mentioning me in your ReadMe :) - glad to help;
but I must point out - sticking the script "just as is" into /usr/local/bin/ won't accomplish much.
The same with Windows users putting somewhere in their $PATH (C:\Windows\ comes to mind);
the script itself would have to start using some saved setup from somewhere,
that's where the whole INI-file thing comes in, there's a pretty easy-to-use python library for .ini-files!

Two things I noticed with your first input "type of game":
First it can be written like so

game = input("""
What game/mod are you using? 
Type in the corresponding number.
        1. Sauerbraten
        2. Assault Cube
        3. Cube
        4. Blood Frontier SVN
       >""")

which makes it a lot clearer IMHO :) .. secondly : what if the user mis-types and presses 'f' !?! :-P
If you're already making Windows-EXEs why not try boa-constructor-ing yourself a nice GUI for this;
I bet it'd really be newbie-friendly if they've got a nice colourful rounded button to press on,
rather than those drab grey keys at their fingertips :-P

DogDancing1 | 2008-01-30 00:26

This is very useful for quick packaging, and will help new mappers a lot.
Nice job!

skiingpenguins | 2008-02-01 00:39

hi,

1 where do i install this?
2 what should i put for:
Where is your installation of Sauerbraten located?
(Where is Sauerbraten installed?

MovingTarget | 2008-02-01 14:41

If your on windoze, you don't have to install it. Just double click on the .exe. In a day or two, I'm coming out with a new version, but I'll help you now.

For where you installed Sauer, if you installed it to the default, type in "C:\Program Files\Sauerbraten" with no quotes.

~MovingTarget

Drakas | 2008-02-01 16:43

IF YOU ARE ON WINDOZE == IF YOU'RE ON WINDOZE != IF YOUR DOG IS ON WINDOZE

Learn how to spell.

Anger: relieved.
Don't hate me :P

MeatROme | 2008-02-10 17:32

How about having some more flow-control !?!
If I start it up and know I've just edited my map and the cfg is okay,
but I've forgotten about the screenshot:
why can't the script call "sauerbraten -l" + map_name,
then when it's finished call "gimp "+last_added_file_of_BMP_type_in_sauerbraten_DIR
.. same for ReadMe ... if none exists yet,
give me the option to create one - with a good preset given by the script itself.

for the "gimp + filename" stuff you'll need to have pre-/re-configure options;
but you'll have them for game-installation-dirs anyway, right?!?! :)

MovingTarget | 2008-02-10 18:14

I already use the ini parser in the script.
I provided an installer that sticks shortcuts to the scrip which is put in $PATH.
And boa-constructor builds GUI's for wxPython, which, last time I checked, is deprecated.
But I may try making one in Tkinter.

~MovingTarget
[ADMIN] moved reply where it belongs

MeatROme | 2008-02-10 20:32

re:iniparser : well, not in the linux version - remember, I asked for the split, so smaller d/l ;)

re:wxPython : it's only called wxwidgets now, isn't it ...
but true boa-constructor is probably outdated :-P,
haven't tinkered with Tkinter or boa in a long time, there's bound to be better tools!

MovingTarget | 2008-02-10 22:10

Darnit!!! Quadropolis did something weird while I was replying, don't know how in the world it got where it did.
I was thinking about pyGTK, but it's waaay too hard to get it into a working Windows binary.
I'll have to research any others.

Oh, and I did the split, if that's what you're saying.

~MovingTarget

User login

Navigation