Script Manual
Posted: Sat Jul 07, 2012 2:09 am
I have read over the STUB Documentation and has been mentioned in another thread it is both difficult for Pip to cover all of the items that could be listed in this "manual."
However, what I would like to do is develop a manual based on user (and Pip's) input.
The manual would use SCREENSHOTS and explain CAREFULLY the entries for folks like myself who have done SOME encapsulation coding before but for whom a short, terse, explanation will not do. Folks could submit their scripts for the manual as well (but note below - duplicate submissions would be merged or the author told that we already have an example for pretty much the same thing)
I would like to get as many contributors as possible to help. Here is the format:
Title of Feature - keep it brief
Description/Purpose of Feature - hold it down to say 40 words or less
Script for Feature - check it before you submit it ...
Breakdown of script - describe the elements of the script using plain English for anyone that would want to mod the game. Avoid using abbreviations. Describe the entries so that most anyone could understand it.
Illustration of script in action - show a screenshot from the game how the script interacts with the program. Simply circle or note on the screenshop using Paint or Photoshop where the script interacts with the game such as "this command places the reinforcements here at this location and then heads them off to attack this objective."
Format of file: plain text file with attached screenshot file(s). For multiple illustrations note where each should be placed.
Start of work: August 15th, 2012.
The file would be a PDF. Hopefully Slitherine would host it. It would be updated monthly on the website (if it has changed). Otherwise I can host it on my server.
I think that a community project is a blast and many of you have put together scripts or are working on them and know the script language very well. A document that we could provide for people would not only help them to understand how it all works but also draw out more creative powers from the customers as well.
Note: if the feature gets added into the game as a plug-in then it would be placed in an archived section of the manual. The plugin that replaced it would be listed after the description.
I would want one helper to assist me in gathering the material together. Title: Technical Associate. You would basically take the files that are sent and place them into a format that we agree on for building the manual. We would review the entries and then I would place them in the document and replace the older document on the server once a month.
I would want someone that understands the script and may be able to catch errors in the text. We also would want to discriminate on some scripts and perhaps merge entries which are on the same topic. Finally, we would need to add the script name and key phrases to an index.
We could start by taking as many of the scripts that we can and adding them into the manual. As long as we are not violating any copyright issues we could show how the existing scripts in the game work too.
If interested please PM me or reply here. We would want to have a short planning "session" to determine the "chapters" needed in the manual. I would basically format the master document. It would be up to the contributors and the Technical Associate to come to an agreement on the format. And of course we would pass it by Pip and Iain for comment.
We should set a limit on the number of entries per month as well. I, for one, could not handle more than say twenty new entries. Others would be welcome to join the "staff" to help the Tech. Associate out. Just send me the final files and I will merge them into the document. Highlight the key words for me and I will do the rest. If someone else wants to help me out that works too. Maybe you are a wiz at custom documents. Works for me!
However, what I would like to do is develop a manual based on user (and Pip's) input.
The manual would use SCREENSHOTS and explain CAREFULLY the entries for folks like myself who have done SOME encapsulation coding before but for whom a short, terse, explanation will not do. Folks could submit their scripts for the manual as well (but note below - duplicate submissions would be merged or the author told that we already have an example for pretty much the same thing)
I would like to get as many contributors as possible to help. Here is the format:
Title of Feature - keep it brief
Description/Purpose of Feature - hold it down to say 40 words or less
Script for Feature - check it before you submit it ...
Breakdown of script - describe the elements of the script using plain English for anyone that would want to mod the game. Avoid using abbreviations. Describe the entries so that most anyone could understand it.
Illustration of script in action - show a screenshot from the game how the script interacts with the program. Simply circle or note on the screenshop using Paint or Photoshop where the script interacts with the game such as "this command places the reinforcements here at this location and then heads them off to attack this objective."
Format of file: plain text file with attached screenshot file(s). For multiple illustrations note where each should be placed.
Start of work: August 15th, 2012.
The file would be a PDF. Hopefully Slitherine would host it. It would be updated monthly on the website (if it has changed). Otherwise I can host it on my server.
I think that a community project is a blast and many of you have put together scripts or are working on them and know the script language very well. A document that we could provide for people would not only help them to understand how it all works but also draw out more creative powers from the customers as well.
Note: if the feature gets added into the game as a plug-in then it would be placed in an archived section of the manual. The plugin that replaced it would be listed after the description.
I would want one helper to assist me in gathering the material together. Title: Technical Associate. You would basically take the files that are sent and place them into a format that we agree on for building the manual. We would review the entries and then I would place them in the document and replace the older document on the server once a month.
I would want someone that understands the script and may be able to catch errors in the text. We also would want to discriminate on some scripts and perhaps merge entries which are on the same topic. Finally, we would need to add the script name and key phrases to an index.
We could start by taking as many of the scripts that we can and adding them into the manual. As long as we are not violating any copyright issues we could show how the existing scripts in the game work too.
If interested please PM me or reply here. We would want to have a short planning "session" to determine the "chapters" needed in the manual. I would basically format the master document. It would be up to the contributors and the Technical Associate to come to an agreement on the format. And of course we would pass it by Pip and Iain for comment.
We should set a limit on the number of entries per month as well. I, for one, could not handle more than say twenty new entries. Others would be welcome to join the "staff" to help the Tech. Associate out. Just send me the final files and I will merge them into the document. Highlight the key words for me and I will do the rest. If someone else wants to help me out that works too. Maybe you are a wiz at custom documents. Works for me!
)