Skip to content
This repository has been archived by the owner on Feb 25, 2022. It is now read-only.

Commit

Permalink
Add rebranding changes from SheepyChris
Browse files Browse the repository at this point in the history
  • Loading branch information
moruzerinho6 committed Jun 14, 2021
1 parent 64330b2 commit 6bd2b3e
Show file tree
Hide file tree
Showing 3 changed files with 68 additions and 100 deletions.
102 changes: 28 additions & 74 deletions pageFiles/themes/moondance/assets/faq.html
Original file line number Diff line number Diff line change
@@ -1,37 +1,21 @@
<h1 class="page-title">FAQ</h1>
<h1 data-translation="general">General</h1>

<h2 data-translation="whatIsFiveThree">What is StepMania 5.3?</h2>
<h2 data-translation="whatIsFiveThree">What is Project OutFox?</h2>

<p data-translation="whatIsFiveThreeExplanation">A project to modernize the 5.0.x/5.1 codebase to improve its performance and provide enhanced
support for modern hardware and operating systems. We are also adding new features, including
those being requested by our community, as well as refurbishing its support of non-dance/4-key
game types, adding new game types, and so forth.</p>
<p data-translation="whatIsFiveThreeExplanation">A project to modernize the StepMania 5.0.12/5.1 codebase to improve its performance and provide enhanced support for modern hardware and operating systems. We are also adding new features, including those being requested by our community, as well as refurbishing its support of non-dance/4-key game types, adding new game types, and so forth.</p>

<h2 data-translation="whatIsMoondance">What is Project Moondance?</h2>

<p data-translation="whatIsMoondanceExplanation">It is a community/umbrella for Team Rizu (the 5.3 dev team), covering 5.3/Project OutFox as well
as other related projects.</p>
<p data-translation="whatIsMoondanceExplanation">It is a community/umbrella for Team Rizu (the Project OutFox dev team), covering Project OutFox as well as other related projects.</p>

<h2 data-translation="willItWorkWithOldStuff">Will it still work with my old songs/themes/etc.?</h2>

<p data-translation="outfoxCompatibility">5.3 builds upon the existing 5.0.12/5.1 beta codebase, and maintaining backwards compatibility
with older content is one of our main priorities (in fact, this is one of the reasons why the
version number is 5.3 rather than skipping to a higher number like 6.0). Content that worked on
5.0.12/5.1 (including songs, themes, and noteskins) should still work on 5.3. If you experience
any issues/weirdness, please report it to us.</p>
<p data-translation="outfoxCompatibility">Project OutFox builds upon the existing StepMania 5.0.12/5.1 beta codebase, and maintaining backwards compatibility with older content is one of our main priorities (in fact, this is one of the reasons why the internal version number is 5.3 rather than skipping to a higher number like 6.0). Content that worked on StepMania 5.0.12/5.1 (including songs, themes, and noteskins) should still work on OutFox. If you experience any issues/weirdness, please report it to us.</p>

<h3 data-translation="noteForDevs">Side note for developers</h3>

<p data-translation="cmdIsDeprecating">Please note that we are deprecating the use of semicolon-separated <code>cmd()</code> blocks
(i.e. &nbsp;<code>OnCommand=cmd(linear,1.5;diffusealpha,1);&nbsp;</code>) as a means of placing
commands on actors in Lua scripts, as this method is a non-standard Lua function that was
created for StepMania, and 5.3 is not optimized with this coding style in mind (themes may
experience performance penalties if they use this method). It is strongly recommended that
function chaining (i.e. code such as
<code>OnCommand=function(self) self:linear(1.5):diffusealpha(1) end,&nbsp;</code>) be used
instead.
</p>
<p data-translation="cmdIsDeprecating">Please note that we are deprecating the use of semicolon-separated <code>cmd()</code> blocks (i.e. &nbsp;<code>OnCommand=cmd(linear,1.5;diffusealpha,1);&nbsp;</code>) as a means of placing commands on actors in Lua scripts, as this method is a non-standard Lua function that was created for StepMania, and OutFox is not optimized with this coding style in mind (themes may experience performance penalties if they use this method). It is strongly recommended that function chaining (i.e. code such as <code>OnCommand=function(self) self:linear(1.5):diffusealpha(1) end,&nbsp;</code>) be used instead.</p>

<h2 data-translation="outfoxWithOtherVersions">Can I install it alongside existing versions?</h2>

Expand All @@ -48,23 +32,16 @@ <h2 data-translation="willThereBeOnlineSupport">Will there be online support?</h
<p data-translation="smoIsDeprecated">The existing SMO functionality is deprecated, but we have future plans to develop a revamped
online system.</p>

<h2 data-translation="whereIsTheSource">Where is the source code?/Why are you not open source?</h2>
<h2 data-translation="whereIsTheSource">Where is the source code? Why are you not open source?</h2>

<p data-translation="whyItsClosedSource">Right now we are not maintaining a public code repository, but we will open one in the future
(with plans for it to succeed 5.1 as the mainline branch in the StepMania repository). As 5.3 is
developing at a rapid pace, allowing source code access at this time would allow users to
compile their own builds based on incomplete work, which would be difficult for us to debug and
support during this phase of development..</p>
<p data-translation="whyItsClosedSource">Right now we are not maintaining a public code repository, but we will open one in the future. As Project OutFox is developing at a rapid pace, allowing source code access at this time would allow users to compile their own builds based on incomplete work, which would be difficult for us to debug and support during this phase of development..</p>

<p data-translation="howWeWillReleaseTheSource">Our code will be licensed under the Apache License 2.0, an open source license used by a variety
of major projects (including Android) that provides stronger protections for our rights to be
attributed for our work (particularly within forks), while maintaining the ability for StepMania
to remain free and open source as it has always been.&nbsp;</p>

<p data-translation="anyQuestionsAboutTheSource"><span style="background-color: transparent;">If you have any questions related to the 5.3
code&nbsp;</span><em style="background-color: transparent;">itself</em><span
style="background-color: transparent;">, feel free to ask one of the development team
members on our Discord server, and we'll be happy to discuss.</span></p>
<p data-translation="anyQuestionsAboutTheSource"><span style="background-color: transparent;">If you have any questions related to the Project OutFox code&nbsp;</span><em style="background-color: transparent;">itself</em><span style="background-color: transparent;">, feel free to ask one of the development team members on our Discord server, and we'll be happy to discuss.</span></p>

<blockquote class="blockquote">

Expand Down Expand Up @@ -96,37 +73,20 @@ <h2 data-translation="howCanIContribute">Are there ways I can contribute?</h2>

<ul>
<li data-translation="reportingBugs">You can report bugs and make feature suggestions on our Discord server.</li>
<li data-translation="joiningTinyFoxes"><a>TinyFoxes&nbsp;</a>is a branch of Project Moondance
that is coordinating and hosting community-produced content for 5.3, such as translations
and other add-ons.</li>
<li data-translation="joiningTinyFoxes"><a href="https://github.com/Tiny-Foxes">TinyFoxes&nbsp;</a>is a branch of Project Moondance that is coordinating and hosting community-produced content for Project OutFox, such as translations and other add-ons.</li>
</ul>

<h2 data-translation="whatIsFiveTwoWhySkip">What is 5.2 and why did you skip over it?</h2>
<h2 data-translation="whatIsFiveTwoWhySkip">What is StepMania 5.2 and why did you skip over it?</h2>

<p data-translation="fiveTwoBrokeCompatibility">5.2 was originally intended to be the next version of StepMania. However, it included a number of
major changes that broke compatibility with previous versions, and were not well-received by the
community and other developers.</p>
<p data-translation="fiveTwoBrokeCompatibility">StepMania 5.2 was originally intended to be the next version. However, it included a number of major changes that broke compatibility with previous versions, and were not well-received by the community and other developers..</p>

<p data-translation="fiveTwoCancelled">5.2 was originally meant to be 5.1. However, in response to the reception, it was officially
delayed in favour of a new 5.1 that was largely an update to 5.0.12 that did not break
compatibility with existing content. This was done under the presumption that the new version
(subsequently renamed 5.2) would eventually be completed. However, this did not end up
happening.</p>
<p data-translation="fiveTwoCancelled">StepMania 5.2 was originally meant to be 5.1. However, in response to the reception, it was officially delayed in favour of a new 5.1 that was largely an update to 5.0.12 that did not break compatibility with existing content. This was done under the presumption that the new version (subsequently renamed 5.2) would eventually be completed. However, this did not end up happening.</p>

<h1 data-translation="technical">Technical</h1>

<h2 data-translation="controllerDoesntWork">My controller doesn't work, but it did on older versions.</h2>

<p data-translation="xinputCompliant">Alpha 4.5 switched to using an XInput-compliant input system by default; additional configuration
is needed to use unrecognized controllers in this mode. See <a>here</a>
for more information on how to map your controller for use in XInput mode on StepMania OutFox.
</p>
<h2 data-translation="controllerDoesntWork">My controller doesn't work, but it did on older versions of StepMania.</h2>

<p data-translation="xinputAndLegacyExplanation"><a>As of Alpha 4.8.1</a>, we
have introduced a HIDAPI-based "Legacy" input system as an option in the Experimental Settings
menu. It is similar in behaviour to the input system seen in SM 5.0, but rewritten. If you are
having difficulty getting a controller to work in XInput mode or if it performed better under
the input handling of previous versions, we recommend that you try it on Legacy mode.</p>
<p data-translation="xinputCompliant">Currently the game features two modes: a HIDAPI-based "Legacy" input system, similar in behaviour to the input system seen in StepMania 5.0, and an XInput-compliant input system (additional configuration is needed to use unrecognized controllers in this mode, see <a href="/help/controllers">here</a> for more information). If you are unable to map any buttons to the game, try switching modes to Legacy, available as an option in the Experimental Settings menu, or follow the guide mentioned above on how to map your controller with XInput.</p>

<h2 data-translation="lagWithRecentProcessor">I have a recent/fast processor and my game is having a lot of problems, why is that?</h2>

Expand All @@ -135,30 +95,21 @@ <h2 data-translation="lagWithRecentProcessor">I have a recent/fast processor and
background activity (i.e. having other programs running in the background, etc.) is a temporary
solution.</p>

<h2 data-translation="simplyLoveCompatibility">Simply Love is not letting me use it on 5.3</h2>
<h2 data-translation="simplyLoveCompatibility">Simply Love is not letting me use it!</h2>

<p data-translation="simplyLoveCompatibilityExplanation">Simply Love does work on 5.3, but since version 4.8, a compatibility warning has been shown by
the theme if an unsupported version of SM is detected. On 4.8, you can press the Escape button
twice to bypass the compatibility warning, but 4.9 blocks this workaround.</p>
<p data-translation="simplyLoveCompatibilityExplanation">Simply Love does work on Project OutFox and since version 5.0, official support has been introduced. With versions 4.8 and 4.9, a compatibility warning is shown by the theme if an unsupported version of StepMania is detected. On 4.8, you can press the Escape button twice to bypass the compatibility warning, but 4.9 blocks this workaround.</p>

<p data-translation="simplyLoveCompatibilityRemoveCheck">The version check can be removed by opening Scripts/SL-SupportHelpers.lua in the theme, and
changing the line&nbsp;</p>
<p data-translation="simplyLoveCompatibilityRemoveCheck">If you prefer utilizing those older SL versions, the check can be removed by opening Scripts/SL-SupportHelpers.lua in the theme, and changing the line&nbsp;</p>

<p data-translation="simplyLoveCompatibilityRemovingCheckFrom"><code>if not (t[2] and (t[2]==0 or t[2]==1)) then return false end</code></p>

<p data-translation="to">to</p>

<p data-translation="simplyLoveCompatibilityRemovingCheckTo"><code>if not (t[2] and (t[2]==0 or t[2]==1 or t[2]==3)) then return false end</code></p>

<p data-translation="simplyLoveCompatibilityWhy">These issues were brought upon by misunderstandings with the theme's developer over our plans for
5.3 (including concerns over the aforementioned lack of public source repository). These
concerns <a>were
able to be resolved</a>, although official support for 5.3 will not be worked on until we
transition to public source availability.</p>
<p data-translation="simplyLoveCompatibilityWhy">These issues were brought upon by misunderstandings with the theme's developer over our plans for Project OutFox (including concerns over the aforementioned lack of public source repository). These concerns <a href="https://github.com/quietly-turning/Simply-Love-SM5/pull/184#issuecomment-717841953">were able to be resolved</a> with version 5.0.</p>

<p data-translation="simplyLoveTinyFoxesFork">An <a>unofficial fork</a> has been
created by Project Moondance's TinyFoxes community team, which seeks to perform additional
tweaks for compatibility and integrations with 5.3</p>
<p data-translation="simplyLoveTinyFoxesFork">An <a href="https://github.com/Tiny-Foxes/Simply-Love-OutFox">unofficial fork</a> is also available and has been forked by Project Moondance's TinyFoxes community team, which seeks to perform additional tweaks for compatibility and integrations with Project OutFox</p>

<h1 data-translation="linux">Linux</h1>

Expand All @@ -171,14 +122,13 @@ <h1 data-translation="macOS">macOS</h1>

<h2 data-translation="issueLaunching">I'm having issues launching the game.</h2>

<p data-translation="noNoteskinsFound">If you receive errors such as "No noteskins found" or other unusual behavior, you will have to
change macOS security settings in order for Project OutFox to operate correctly. The OS does not
trust unsigned applications, and prevents access to external files unless given manual
permission by the user.</p>
<p data-translation="noNoteskinsFound">If you receive errors such as "No noteskins found" or other unusual behavior, you will have to change macOS security settings in order for Project OutFox to operate correctly. MacOS performs a process every time a new program has been downloaded called quarantine, which will require Gatekeeper (The OS's security manager) to verify its signature. The OS does not trust unsigned applications, and prevents access to external files unless given manual permission by the user.</p>


<p data-translation="quarantineFix">To do this, open Terminal and run the following command: <code>xattr -dr com.apple.quarantine /path/to/StepMania</code>, replacing <code>/path/to/StepMania&nbsp;</code>with the path to the directory containing the StepMania executable (manually typing it out, or dragging the folder containing the game executable directly onto the window to fill it automatically).</p>

<figure class="" data-label="Grabaci%C3%B3n%20de%20pantalla%202021-05-27%20a%20la(s)%2013.35.09.mp4" data-video="https://josevarela.xyz/img/Grabaci%C3%B3n%20de%20pantalla%202021-05-27%20a%20la(s)%2013.35.09.mp4">&nbsp;</figure>

<p data-translation="olderMacBuilds">On older builds, macOS Catalina also generated a message stating that the game was requesting
permission to &nbsp;receive keystrokes from any application. This was a side effect of previous
code that has since been removed.</p>
Expand All @@ -195,6 +145,10 @@ <h2 data-translation="ancientIntelGraphics">I have ancient Intel graphics and th

<p data-translation="wddm1Driver">If your log (Installation directory/Logs) shows <code>WDDM1.0</code> or <code>WDDM1.1</code> at the end of the graphics card name:</p><pre data-translation="lastSeenDriver"><code>00:00.505: Last seen video driver: Intel(R) 82945G Express Chipset Family (Microsoft Corporation - WDDM 1.0)</code></pre>

<p data-translation="microsoftGDIRenderer">or the log shows <code>Microsoft GDI</code> as the renderer, then you are running the OpenGL-crippled "Windows" driver that is downloaded on a fresh install. StepMania 5.3 will not work on these drivers, as we do not support DirectX anymore (the old D3D renderer that 5.0.12/5.1 has) There is a list of drivers at this site location which may help, but for some of these cards, you need to keep your Windows 7 install disc handy!</p>
<p data-translation="microsoftGDIRenderer">or the log shows <code>Microsoft GDI</code> as the renderer, then you are running the OpenGL-crippled "Windows" driver that is downloaded on a fresh install. Project OutFox will not work on these drivers, as we do not support DirectX anymore (the old D3D renderer that 5.0.12/5.1 has) There is a list of drivers at this site location which may help, but for some of these cards, you need to keep your Windows 7 install disc handy!</p>

<p data-translation="intelGraphicsSupport">&nbsp;<a href="https://www.intel.com/content/www/us/en/support/articles/000005733/graphics.html" rel="noreferrer noopener" tabindex="0" target="_blank" title="https://www.intel.com/content/www/us/en/support/articles/000005733/graphics.html">https://www.intel.com/content/www/us/en/support/articles/000005733/graphics.html</a></p>
<p>&nbsp;<a href="https://www.intel.com/content/www/us/en/support/articles/000005733/graphics.html" rel="noreferrer noopener" tabindex="0" target="_blank" title="https://www.intel.com/content/www/us/en/support/articles/000005733/graphics.html">https://www.intel.com/content/www/us/en/support/articles/000005733/graphics.html</a></p>

<p data-translation="intel3000Graphics">If you happen to use the Intel HD Graphics 3000 graphics chip, there is a technical workaround below that will restore OpenGL functionality on Windows 10 and could be worth a shot if you're experienced with your operating system.</p>

<p data-translation="intelGist">&nbsp;<a href="https://gist.github.com/rb-dahlb/26f316c5b6089807a139fc44ee69f0d1">https://gist.github.com/rb-dahlb/26f316c5b6089807a139fc44ee69f0d1</a></p>
15 changes: 10 additions & 5 deletions template.json
Original file line number Diff line number Diff line change
Expand Up @@ -530,11 +530,6 @@
"content": "xinputCompliant",
"jumpLine": true
},
{
"type": "p",
"jumpLine": true,
"content": "xinputAndLegacyExplanation"
},
{
"type": "h2",
"jumpLine": true,
Expand Down Expand Up @@ -664,6 +659,16 @@
"type": "p",
"content": "intelGraphicsSupport",
"jumpLine": true
},
{
"type": "p",
"content": "intel3000Graphics",
"jumpLine": true
},
{
"type": "p",
"content": "intelGist",
"jumpLine": true
}
],
"static-pages-move-freely": [
Expand Down
Loading

0 comments on commit 6bd2b3e

Please sign in to comment.