Skip to content

Commit

Permalink
Update dependency versions and documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
libertyernie committed Feb 6, 2016
1 parent 2a6dbeb commit 68e4dde
Show file tree
Hide file tree
Showing 6 changed files with 79 additions and 76 deletions.
12 changes: 6 additions & 6 deletions SSSEditor/About.html
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@
</style>
</head>
<body>
<h1>SSS Editor 3.6</h1>
<h3>Copyright (c) 2013-2015 libertyernie</h3>
<h1>SSS Editor 3.7</h1>
<h3>Copyright (c) 2013-2016 libertyernie</h3>
<p>
Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
Expand Down Expand Up @@ -48,12 +48,12 @@ <h3>Copyright (c) 2013-2015 libertyernie</h3>
<a target="_blank" href="http://www.microsoft.com/web/webpi/eula/net_library_eula_enu.htm">see here for license terms</a>
</li>
<li>
<b><a target="_blank" href="https://github.com/Antaris/RazorEngine">RazorEngine</a> (3.7.0):</b>
<a target="_blank" href="https://github.com/Antaris/RazorEngine/blob/3.7.0/LICENSE.md">see here for license terms</a> (Apache License 2.0)
<b><a target="_blank" href="https://github.com/Antaris/RazorEngine">RazorEngine</a> (3.7.7):</b>
<a target="_blank" href="https://github.com/Antaris/RazorEngine/blob/3.7.7/LICENSE.md">see here for license terms</a> (Apache License 2.0)
</li>
<li>
<b><a target="_blank" href="http://www.newtonsoft.com/json">Newtonsoft.Json</a> (7.0.1):</b>
<a target="_blank" href="https://github.com/JamesNK/Newtonsoft.Json/blob/7.0.1/LICENSE.md">see here for license terms</a> (MIT License)
<b><a target="_blank" href="http://www.newtonsoft.com/json">Newtonsoft.Json</a> (8.0.2):</b>
<a target="_blank" href="https://github.com/JamesNK/Newtonsoft.Json/blob/8.0.2/LICENSE.md">see here for license terms</a> (MIT License)
</li>
</ul>
</body>
Expand Down
8 changes: 4 additions & 4 deletions SSSEditor/SSSEditor.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -54,12 +54,12 @@
<CodeAnalysisRuleSet>MinimumRecommendedRules.ruleset</CodeAnalysisRuleSet>
</PropertyGroup>
<ItemGroup>
<Reference Include="Newtonsoft.Json, Version=7.0.0.0, Culture=neutral, PublicKeyToken=30ad4fe6b2a6aeed, processorArchitecture=MSIL">
<HintPath>..\packages\Newtonsoft.Json.7.0.1\lib\net40\Newtonsoft.Json.dll</HintPath>
<Reference Include="Newtonsoft.Json, Version=8.0.0.0, Culture=neutral, PublicKeyToken=30ad4fe6b2a6aeed, processorArchitecture=MSIL">
<HintPath>..\packages\Newtonsoft.Json.8.0.2\lib\net40\Newtonsoft.Json.dll</HintPath>
<Private>True</Private>
</Reference>
<Reference Include="RazorEngine, Version=3.7.0.0, Culture=neutral, PublicKeyToken=9ee697374c7e744a, processorArchitecture=MSIL">
<HintPath>..\packages\RazorEngine.3.7.0\lib\net40\RazorEngine.dll</HintPath>
<Reference Include="RazorEngine, Version=3.7.7.0, Culture=neutral, PublicKeyToken=9ee697374c7e744a, processorArchitecture=MSIL">
<HintPath>..\packages\RazorEngine.3.7.7\lib\net40\RazorEngine.dll</HintPath>
<Private>True</Private>
</Reference>
<Reference Include="System" />
Expand Down
40 changes: 20 additions & 20 deletions SSSEditor/SSSEditor.txt
Original file line number Diff line number Diff line change
Expand Up @@ -19,32 +19,32 @@ Changes in 3.7:
Notes:
* Internet Explorer 8 or higher is now required.
* Three additional libraries are included: Microsoft.AspNet.Razor (part
of Microsoft's ASP.NET), RazorEngine (a templating engine built around
Razor), and Newtonsoft.Json (a JSON library for communicating with the
embedded web browser.)
* Although new versions of Microsoft.AspNet.Razor are open source, this one
(which runs on .NET 4.0) is not, so check the licensing terms here:
http://www.microsoft.com/web/webpi/eula/net_library_eula_enu.htm
of Microsoft's ASP.NET), RazorEngine (a templating engine built around
Razor), and Newtonsoft.Json (a JSON library for communicating with the
embedded web browser.)
* Although new versions of Microsoft.AspNet.Razor are open source, this one
(which runs on .NET 4.0) is not, so check the licensing terms here:
http://www.microsoft.com/web/webpi/eula/net_library_eula_enu.htm

-------- Stage Control Guide --------

C | Icon | 0. [ BATTLEFIELD ↓] mmm [X]
C | Icon | [PP] [ss] SS II [ii] [↑][↓]

BATTLEFIELD The stage to load. You can choose a stage from the dropdown or use
the "ss" field (see below) to enter a stage ID in decimal.
mmm The song that plays on the stage - only appears if you have a
Stage-Dependent Song Loader code for this stage in your codeset.
C A color indicating whether your stage will be shown on My Music
and/or chosen on random - see below.

## (hex) The item's position in the list you're currently looking at.
PP (hex) The position on column of the stage/icon definition.
On columns 2 and 3, change this value to determine which stage appears.
ss (dec) The stage ID. Editable on column 1.
SS (hex) The stage ID.
II (hex) The icon ID.
ii (dec) The icon ID. Editable on column 1.
BATTLEFIELD The stage to load. You can choose a stage from the dropdown or use
the "ss" field (see below) to enter a stage ID in decimal.
mmm The song that plays on the stage - only appears if you have a
Stage-Dependent Song Loader code for this stage in your codeset.
C A color indicating whether your stage will be shown on My Music
and/or chosen on random - see below.

## (hex) The item's position in the list you're currently looking at.
PP (hex) The position on column of the stage/icon definition.
On columns 2 and 3, change this value to determine which stage appears.
ss (dec) The stage ID. Editable on column 1.
SS (hex) The stage ID.
II (hex) The icon ID.
ii (dec) The icon ID. Editable on column 1.

To change a stage's position in the list, use the up/down buttons on the right.
When clicking multiple times, you can click a button once and then press the spacebar repeatedly.
Expand Down
4 changes: 2 additions & 2 deletions SSSEditor/packages.config
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<packages>
<package id="Microsoft.AspNet.Razor" version="2.0.30506.0" targetFramework="net40-Client" />
<package id="Newtonsoft.Json" version="7.0.1" targetFramework="net40-Client" />
<package id="RazorEngine" version="3.7.0" targetFramework="net40-Client" />
<package id="Newtonsoft.Json" version="8.0.2" targetFramework="net40-Client" />
<package id="RazorEngine" version="3.7.7" targetFramework="net40-Client" />
</packages>
7 changes: 5 additions & 2 deletions SongManager/BrawlSongManager.txt
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,8 @@ To add a song, drag a .BRSTM or .WAV onto the menu and enter a filename.
Right-click the .BRSTM in the menu for other options (Export, Rename, Delete).

KEYBOARD SHORTCUTS:
PageUp: go up one song (focus does not need to be on the song list)
PageDown: go down one song (focus does not need to be on the song list)
PageUp: go up one song (focus does not need to be on the song list)
PageDown: go down one song (focus does not need to be on the song list)

----------------------------------------

Expand All @@ -44,6 +44,9 @@ in the two files are different, the text box will be colored red.

----------------------------------------

Use the "change directory" dialog to select the folder that has BRSTM files in
it. This could be sound/strm (or sound/sfx with the Custom Sound Engine.)

Hint: In the "change directory" dialog, select your SD card and hit OK. If
there are no .brstm files in the root of your SD card, the program should jump
to /private/wii/app/RSBE/pf/sound/strm or /projectm/pf/sound/strm instead, if
Expand Down
84 changes: 42 additions & 42 deletions StageManager/BrawlStageManager.txt
Original file line number Diff line number Diff line change
Expand Up @@ -23,13 +23,13 @@ You can also run BrawlStageManager.exe from the root of your SD card for the
same effect.

KEYBOARD SHORTCUTS:
PageUp: Go up one stage (focus does not need to be on the stage list)
PageDown: Go down one stage (focus does not need to be on the stage list)
Tilde (~): Display PAT0 modification dialog
Left bracket ([): Replace border around icon (4-pixel margin) with pixels from
border.png in application folder, or one that comes with Stage
Manager if no border.png exists
Right bracket (]): Generate a new FrontStname using a configurable font
PageUp: Go up one stage (focus does not need to be on the stage list)
PageDown: Go down one stage (focus does not need to be on the stage list)
Tilde (~): Display PAT0 modification dialog
Left bracket ([): Replace border around icon (4-pixel margin) with pixels from
border.png in application folder, or one that comes with Stage
Manager if no border.png exists
Right bracket (]): Generate a new FrontStname using a configurable font

-------- Notes --------

Expand All @@ -47,47 +47,47 @@ to the mu_menumain (for My Music) from the Tools menu.
The left side of the window has a list of stage .PAC files in the current
directory; you can change the directory through the Options menu. Choosing a
stage file will display:
* The filename, root node name, and filesize of the .PAC
* The filename, internal name, and filesize of the matching .rel file (if it exists)
* By default, the program searches for .rel files in ../../module, but
through the Options menu you can tell the program to search the current
directory instead.
* If the .rel file has the wrong ID for the stage it's replacing, a button
will appear allowing you to fix it automatically.
* Any MSBin nodes in the .pac file, starting with the last (shown by default)
* Some stage authors often put info about the stage in these nodes. This
program will display them read-only; you can edit them with BrawlBox.
* If Options>Render Models is checked: the 3D models that make up the stage itself
* You can hide a particular texture by unchecking it in the Model Textures list
* Note: using "Preview All Models" in BrawlBox is another way to examine a stage
* If Options>Load .brstms is checked: any .brstms associated with the stage
* Select the .brstm from the small menu to the left of the audio player.
* You can export or delete the .brstm by right-clicking the menu.
* You can replace the .brstm by dragging a new .brstm onto the audio player.
* The filename, root node name, and filesize of the .PAC
* The filename, internal name, and filesize of the matching .rel file (if it exists)
* By default, the program searches for .rel files in ../../module, but
through the Options menu you can tell the program to search the current
directory instead.
* If the .rel file has the wrong ID for the stage it's replacing, a button
will appear allowing you to fix it automatically.
* Any MSBin nodes in the .pac file, starting with the last (shown by default)
* Some stage authors often put info about the stage in these nodes. This
program will display them read-only; you can edit them with BrawlBox.
* If Options>Render Models is checked: the 3D models that make up the stage itself
* You can hide a particular texture by unchecking it in the Model Textures list
* Note: using "Preview All Models" in BrawlBox is another way to examine a stage
* If Options>Load .brstms is checked: any .brstms associated with the stage
* Select the .brstm from the small menu to the left of the audio player.
* You can export or delete the .brstm by right-clicking the menu.
* You can replace the .brstm by dragging a new .brstm onto the audio player.
You can use Page Up and Page Down to go up and down the stage list, even when
it doesn't have focus.

Stage Manager can also perform certain operations on stage and .rel files:
* Right-click on the button to pull up a menu, which lets you delete the
.pac file or the .rel file. You can also export both files, a .brstm
file (in some cases), and all stage portraits to a folder, which you
can then import later by dragging the folder onto the center panel.
* Drag and drop a .pac file onto the left-hand stage list to copy it to the
working directory. The program will ask what filename to save it as.
* Drag and drop a .pac or .rel file onto the center information display to
replace the current .pac or .rel file. Windows will ask before overwriting.
* Right-click on the button to pull up a menu, which lets you delete the
.pac file or the .rel file. You can also export both files, a .brstm
file (in some cases), and all stage portraits to a folder, which you
can then import later by dragging the folder onto the center panel.
* Drag and drop a .pac file onto the left-hand stage list to copy it to the
working directory. The program will ask what filename to save it as.
* Drag and drop a .pac or .rel file onto the center information display to
replace the current .pac or .rel file. Windows will ask before overwriting.

The right sidebar will display (top to bottom):
* Stage preview (MelSelmapPrevbase)
* Stage icon (MenSelmapIcon)
* Icon number (PAT0 key; XX in MenSelmapIconXX)
* "Generate name" button (same as "]" button on keyboard)
* Stage name (MenSelmapFrontStname)
* Series icon (normally MenSelchrMark, but in my pack I sometimes rename
it to SeriesIcon to avoid confusion)
* Game logo (MenSelmapMark)
* A filesize bar that compares your sc_selmap size to the one in the game -
going over this limit could cause freezing at the stage select screen!
* Stage preview (MelSelmapPrevbase)
* Stage icon (MenSelmapIcon)
* Icon number (PAT0 key; XX in MenSelmapIconXX)
* "Generate name" button (same as "]" button on keyboard)
* Stage name (MenSelmapFrontStname)
* Series icon (normally MenSelchrMark, but in my pack I sometimes rename
it to SeriesIcon to avoid confusion)
* Game logo (MenSelmapMark)
* A filesize bar that compares your sc_selmap size to the one in the game -
going over this limit could cause freezing at the stage select screen!
To replace one of these images, drag and drop an image file onto it. You can
also right-click on the image and choose Replace or Export.

Expand Down

0 comments on commit 68e4dde

Please sign in to comment.