actions/itgmania212121
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Various changes to things in the Docs folder:

Browse Source 
* remove unused WindowsNotes.txt
* various sm-ssc -> StepMania (and similar) changes
* Rewrote a bit of recommended_practices.txt
* Fix a copy/paste typo in anatomy_of_an_actor.lua
* many other things I can't remember; namely newlines at the end of files
This commit is contained in:
freem
2014-09-14 19:17:17 -05:00
parent b20fe48bba
commit 64cd9f898d
12 changed files with 42 additions and 84 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Docs/Devdocs/CodingStyle.txt
+7 -6
View File
@@ -1,6 +1,6 @@
sm-ssc/SM5 Code Style Guidelines
StepMania 5 Code Style Guidelines
--------------------------------------------------------------------------------
The sm-ssc/SM5 code style guidelines are as follows:
The StepMania 5 code style guidelines are as follows:
1) Follow the current coding conventions set forth in the source code.
This means use tabs. AJ prefers tabs have a width of 4. Visual Studio and web
@@ -34,8 +34,9 @@ if( anotherCondition )
lotsofstuff();
}
Variable naming conventions seem to be Hungarian, with m_ being used for
class member variables.
Variable naming conventions are largely Hungarian, with m_ being used for
class member variables. Some newer code is forgoing the use of Hungarian
prefixes.
2) Remove any unnecessary whitespace. "Unnecessary" whitespace includes tabs
at the end of } characters, tabs that lead nowhere, like this one:
@@ -69,7 +70,7 @@ inclusion.)
* in that instance. All new copyright notices should follow this style as well,
* for consistency's sake.
*/
/* use of long comments for one line is discouraged (with exceptions) */
// usually, it will will get cleaned up into this style, but there are exceptions:
@@ -91,4 +92,4 @@ void SomeFunction(size_t /*ACTUAL DATA TYPE*/)
* Pre-existing comments are usually trimmed to meet the 80-column width if they
* go way overboard. */
5) There are no other rules (yet).
5) There are no other rules (yet).
Docs/Devdocs/CompileFlags.txt
+11 -9
View File
@@ -1,17 +1,19 @@
sm-ssc has a few compile flags that are helpful to know, as well as ones
inherited from StepMania.
StepMania has a few compile flags that are helpful to know, as well as one
inherited from sm-ssc that should be nuked.
================================================================================
stepmania:
================================================================================
WITHOUT_NETWORKING
Disables all networking stuff (SMO).
Disables all networking stuff (e.g. StepMania Online).
--------------------------------------------------------------------------------
HAVE_VERSION_INFO
If this isn't defined, passing in --version will only show the name of the
current StepMania version, no build number or date.
Please define HAVE_VERSION_INFO if you can when building StepMania.
================================================================================
sm-ssc:
================================================================================
SSC_FUTURES
{todo}
--------------------------------------------------------------------------------
HAVE_VERSION_INFO
If this isn't defined, passing in --version will only show the name of the
current sm-ssc version, no build number or date.
Please define HAVE_VERSION_INFO if you can when building sm-ssc.
A highly deprecated thing. Anything related to this flag should be removed.
Docs/Devdocs/GoldenRules.txt
+1 -1
View File
@@ -14,4 +14,4 @@ Don't get burned out from nonstop development.
accepted and integrated. Common sense, but a golden rule nevertheless.
4) Anyone who decides to theme during development is willing to accept that
occasionally, changes to the default and/or fallback theme will break things.
occasionally, changes to the default and/or fallback theme will break things.
Docs/Devdocs/SMO_protocol-aj.txt
+4 -4
View File
@@ -8,7 +8,7 @@ This has nothing to do with the server versions (see below)
(NETPROTOCOLVERSION in NetworkSyncManager.h)
1: StepMania 3.9 (SMLan?)
2: StepMania 3.95
3: StepMania 4 alphas/sm-ssc v1.0 RC1-Final
3: StepMania 4 alphas, sm-ssc v1.0-v1.2.5, StepMania 5
==Server Versions==
1: SMLan (old)
@@ -31,8 +31,8 @@ Commands C2S 012-001 and 012-001: when there is no password the 'password' field
The default port is 8765/tcp, though this is actually assigned to Ultraseek HTTP
by the IANA (see http://www.iana.org/assignments/port-numbers).
A sm-ssc version of a online server for StepMania will use the currently
unassigned port 48040/tcp (and/or udp if the need arises).
A modern/official online server for StepMania will use the currently unassigned
port 48040/tcp (and/or udp if the need arises). (Port number subject to change.)
The protocol is packaged in "EzSockets Data Packets".
@@ -551,4 +551,4 @@ Payload:
0x01 Max players
NT Player1 name
...
NT Last player (PlayerN) name
NT Last player (PlayerN) name
Docs/Devdocs/SMXML.txt
+1 -1
View File
@@ -31,4 +31,4 @@ from the web site to StepMania for things like in-game uploads (instead of going
to stepmaniashare.com)"[1]
__________________________________________________________
[1] http://old.stepmania.com/forums/showthread.php?t=24203
[2] http://old.stepmania.com/test.smxml
[2] http://old.stepmania.com/test.smxml
Docs/Devdocs/WarpNotes.txt
+1 -1
View File
@@ -14,4 +14,4 @@ beat 453.72919 = 107.04103 seconds
00:47.228: fDeltaBeat = (NextBPMSeg 0.790333 - abs(fBPS 0.750000)) + (nextStartRow 21576 - thisRow 21384)
00:47.228: ==TimingData Delta as Beats==
00:47.228: fDeltaBeat = 4.000000 (beat)
00:47.228: fDeltaBeat = (NextBPMSeg 0.790333 - abs(fBPS 0.750000)) + (nextStartRow 21576 - thisRow 21384)
00:47.228: fDeltaBeat = (NextBPMSeg 0.790333 - abs(fBPS 0.750000)) + (nextStartRow 21576 - thisRow 21384)
Docs/Devdocs/versioning.txt
+5 -8
View File
@@ -2,11 +2,8 @@
Version info displayed to the user.
These are the 'official' version designations:
* "experimental: pre-release versions
* "private beta v0.0": hmm, think about it for a second there.
==Public versions below this line==
* "v0.0 alpha #": Alpha versions (bug squashing, polishing until we reach beta)
* "v0.0 beta #": Beta versions (bug squashing, _focus_ is on high priority bugs)
* "v0.0 rc#": Release Candidates (if there are no problems, move on to final)
* "v0.0": Final Releases
These are the 'official' version designations:
* "v5.0 alpha #": Alpha versions (bug squashing, polishing until we reach beta)
* "v5.0 beta #": Beta versions (bug squashing, _focus_ is on high priority bugs)
* "v5.0 rc#": Release Candidates (if there are no problems, move on to final)
* "v5.0.0": Final Releases
Docs/Themerdocs/Examples/anatomy_of_an_actor.lua
+1 -1
View File
@@ -58,7 +58,7 @@ Def.Actor{
self:playcommand("Tera", {foo= 1, bar= 2})
end,
TeraCommand= function(self, params)
Trace("Exa command running for " .. self:GetName() .. ": " .. params.foo .. ", " .. params.bar)
Trace("Tera command running for " .. self:GetName() .. ": " .. params.foo .. ", " .. params.bar)
-- Broadcast a message that will execute the Giga command for every actor
-- that has it.
MESSAGEMAN:Broadcast("Giga", {foo= 1, bar= 2})
Docs/Themerdocs/fontini.txt
+1 -1
View File
@@ -1,4 +1,4 @@
SM4 Font .ini values
StepMania 5 Font .ini values
[common]
CapitalsOnly - If set to 1, lowercase letters are drawn with uppercase letters instead.
Docs/Themerdocs/recommended_practices.txt
+9 -31
View File
@@ -1,34 +1,12 @@
Recommended Practices when theming for sm-ssc
---------------------------------------------
1) Use the --theme= command line parameter to switch between themes quickly.
Recommended Practices when theming for StepMania
------------------------------------------------
1) Use the --theme= command line parameter to load StepMania with a specific theme.
This way, you don't have to deal with the theme switch and all the possible
nonsense errors that might come up (due to you having a different amount of
song group colors, timer warning states, etc.), and you can quickly switch
themes if you work on many of them at once.
2) If you want to create a theme that targets both regular StepMania 4 and
sm-ssc, there are a few precautions to take care of.
2a) First, decide if you want to develop it on sm-ssc first or SM4 first. It is
usually easier to deal with making the theme in normal SM4 and using _portKit-SM4
to get the theme running up in sm-ssc.
If you do decide to make the theme for sm-ssc first, be prepared to fill in a lot
of files that sm-ssc _fallback makes empty for you, as the metrics, graphics, and
BGAnimations from SM4's default theme will be loaded instead of sm-ssc's _fallback.
2b) sm-ssc's _fallback theme defines a variable, SSC, like so:
[code]SSC = (ProductID() == "sm-ssc");[/code]
This will return true if it's sm-ssc, or false if it's SM4.
You should define this in a script (00 themeInfo.lua is a good place), so that
SM4 will be able to recognize it.
With this "SSC guard" in place, you can now wrap things in "if SSC then"
statements if they won't work on SM4. You can also provide alternatives if the
player isn't using sm-ssc, since sometimes SM4 will have an approximation or
alternate way to get the data.
3) When dealing with frame size errors or theme code errors, don't just hide the
2) When dealing with frame size errors or theme code errors, don't just hide the
dialog and pretend they don't exist. Good themers fix these problems instead of
releasing the theme and saying "oh, just play it in fullscreen mode".
@@ -36,15 +14,15 @@ If you have hidden the error dialogs, you'll need to modify Preferences.ini.
Find the IgnoredDialogs= line and remove everything after the = sign. You will
now recieve the error messages in windowed mode again.
4) While this is a SSC-specific practice, having a themeInfo file set up in
your theme's Scripts directory is a good way to store information about the
theme (e.g. version number, date, product code, etc.)
3) While this is not required, having a themeInfo file set up in your theme's
Scripts directory is a good way to store information about the theme (e.g.
version number, date, product code, etc.)
An example of a themeInfo script:
[code]
themeInfo = {
Name = "your theme's name",
Name = "Theme Name",
Version = "v1.0", -- typically a float or string. floats are easier to compare.
Date = "20100426 1115",
Date = "20140914 1902",
};
[/code]
Docs/WindowsNotes.txt
-20
View File
@@ -1,20 +0,0 @@
[Redistributables]
You may have to download the Visual C++ Redistritable Packages in order to
run the game. The link is available here:
http://www.microsoft.com/en-us/download/details.aspx?id=30679
[Using Google Chrome?]
If you are using Google Chrome as your primary web browser, you will have to perform some extra steps to get stepmania:// URI handling to work:
Find your user data
Windows XP: C:\Documents and Settings\<USERNAME>\Local Settings\Application Data\Google\Chrome\User Data
Windows Vista/7: C:\Users\<USERNAME>\AppData\Local\Google\Chrome\User Data
Add your protocol to the 'Local State' file under the 'protocol_handler' section, as such:
"protocol_handler": {
"excluded_schemes": {
...
"stepmania": false,
...
}
Docs/license-ext/readme
+1 -1
View File
@@ -1 +1 @@
lots of license documentation for something sm-ssc uses? it goes in here.
lots of license documentation for something StepMania uses? it goes in here.