1
PlaneShift Mods / Improved help.xml
« on: January 22, 2012, 03:42:42 pm »
As weltall committed the patches for the new help system today I thought I made my working draft of an improved in-game help available too. This is still work in progress but as far as I see it includes already all the information of the original PS help and adds a lot more stuff (With one exception, it doesn't include any GM/dev commands at the moment. As this is meant for players I also don't intend to include those myself but if a dev/GM feels like adding them please do so).
Mostly I want to know if there is a general interest in something like this. So a few replies would be appreciated.
For now this will only work with self-compiled clients (need at least PS SVN revision 8024). But the next official client of PS should included all help system improvements needed to use this help.xml replacement.
Then I needed a skin for the images used in the help file. I chose BoNeeSkin for this...as it's CC licensed, pretty complete and easy to adjust. In the end this should work well with all skins so if anyone has interest in making it work with another skin feel free to contact me and ask how. But I wanted to express my gratitude to Bonifarzia and Neeno for their skin.
Okay...but what the hell is this even about. Mhh...lets see:
And as I said...this is still a very early draft and far from being complete. For now not even the part describing all the windows in PS is complete (and I have to admit I'm a bit afraid of the options-window. That will be really a lot to type ). All help is very welcomed if someone is up for it.
First off, I'm not a English native speaker...so there will be endless typos, bad phrasings and grammar errors. Be a spelling-nazi this one time...and poke me about my errors.
Also I would love to have a lot of general game informations stuff in the help like race descriptions or monster descriptions. But here the problems start already...I suck at writing. Everything on the PS website and the PS wiki is ABC licensed and can't be reused. So if someone feels like writing a summery about Klyros, dwarves, Clackers or whatever and doesn't copy and paste from the PS websites please send them to me so that I can included those texts in the help file.
Next problem...the spoiler part. I don't have the slightest clue who trains what and where I can mine. I would like to included all such information as well...even if I never cared about them. So if anyone could give me access to a recent spoiler page and the permission to reuse that stuff I would be grateful. (Of course even more if someone wants to include such information in the help.xml him/herself)
Also the help file is CC licensed (Attribution-NonCommercial-ShareAlike 3.0 Unported (CC BY-NC-SA 3.0) so please reuse this if you want for your own additions. Feel free to create a section with the rules of your guild and hand it out to all your guild members.
So...if you find this interesting, work with a recent trunk client and want to try it out get thethe help.xml. Install the skin as usual (just copy it in art/skins and select it in pslaunch). The help.xml must be copied to data/help.xml (replacing the old help.xml there). If you use a translation of PS you must replace help.xml in the directory of the translation you use (for example: lang/deutsch/data/help.xml)
Changes to BoNeeSkin-v2.7
Last but not least I have a question. Does anyone know what license the posts in this forum are...especially http://www.hydlaaplaza.com/smf/index.php?topic=31960.0
Would be nice to include the rules in the helpfile...but could be a bit hard to ask Dajoji for permission. And if they are seen as PS property and ABC licensed it won't work out.
Edit:
- Added links to images hosted on an alternative provider
Edit2:
- And removed the alternative images again
Mostly I want to know if there is a general interest in something like this. So a few replies would be appreciated.
For now this will only work with self-compiled clients (need at least PS SVN revision 8024). But the next official client of PS should included all help system improvements needed to use this help.xml replacement.
Then I needed a skin for the images used in the help file. I chose BoNeeSkin for this...as it's CC licensed, pretty complete and easy to adjust. In the end this should work well with all skins so if anyone has interest in making it work with another skin feel free to contact me and ask how. But I wanted to express my gratitude to Bonifarzia and Neeno for their skin.
Okay...but what the hell is this even about. Mhh...lets see:
And as I said...this is still a very early draft and far from being complete. For now not even the part describing all the windows in PS is complete (and I have to admit I'm a bit afraid of the options-window. That will be really a lot to type ). All help is very welcomed if someone is up for it.
First off, I'm not a English native speaker...so there will be endless typos, bad phrasings and grammar errors. Be a spelling-nazi this one time...and poke me about my errors.
Also I would love to have a lot of general game informations stuff in the help like race descriptions or monster descriptions. But here the problems start already...I suck at writing. Everything on the PS website and the PS wiki is ABC licensed and can't be reused. So if someone feels like writing a summery about Klyros, dwarves, Clackers or whatever and doesn't copy and paste from the PS websites please send them to me so that I can included those texts in the help file.
Next problem...the spoiler part. I don't have the slightest clue who trains what and where I can mine. I would like to included all such information as well...even if I never cared about them. So if anyone could give me access to a recent spoiler page and the permission to reuse that stuff I would be grateful. (Of course even more if someone wants to include such information in the help.xml him/herself)
Also the help file is CC licensed (Attribution-NonCommercial-ShareAlike 3.0 Unported (CC BY-NC-SA 3.0) so please reuse this if you want for your own additions. Feel free to create a section with the rules of your guild and hand it out to all your guild members.
So...if you find this interesting, work with a recent trunk client and want to try it out get thethe help.xml. Install the skin as usual (just copy it in art/skins and select it in pslaunch). The help.xml must be copied to data/help.xml (replacing the old help.xml there). If you use a translation of PS you must replace help.xml in the directory of the translation you use (for example: lang/deutsch/data/help.xml)
Changes to BoNeeSkin-v2.7
- helpwindow.xml: Changed to pawsDocumentView to work with SVN trunk and enable images in the help window
- dialog.xml: Copied the latest changes from trunk to make the skin work with trunk
- chardescwindow.xml: Enabled the spellchecker for char descriptions
- questnotebook.xml: Enabled the spellchecker for quest notes
- shortcutwindow.xml: Enabled the spellchecker for the command text box (Not sure if this is really helpful as most commands aren't exactly words...but some people tend to write RP-shortcuts here so having the ability to spellcheck might be nice here too)
- guildwindow.xml: Enabled the spellchecker for the MOTD
- chat.xml: Disabled "always on top"...my chat window covers a quarter of the screen...I want to be able to still change options with it visible.
- added petition.xml and enabled the spellchecker for the text
- added a few images for the help file to the skin archive and to imagelist.xml
- added a changelog to README.txt
Last but not least I have a question. Does anyone know what license the posts in this forum are...especially http://www.hydlaaplaza.com/smf/index.php?topic=31960.0
Would be nice to include the rules in the helpfile...but could be a bit hard to ask Dajoji for permission. And if they are seen as PS property and ABC licensed it won't work out.
Edit:
- Added links to images hosted on an alternative provider
Edit2:
- And removed the alternative images again