Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ListenerJubatus committed Feb 18, 2020
1 parent 7fb898c commit fc91ab0
Showing 1 changed file with 18 additions and 11 deletions.
29 changes: 18 additions & 11 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,26 @@
Introduction
-----------
Lambda (formerly FiftyOne) is a modern, high-definition theme for StepMania 5.x. It is designed to serve as the default theme for StepMania 5.1; it features a clean aesthetic with bold colors that reflects modern design trends, yet still maintains a suitable level of energy for a rhythm game. Under the hood, it's also a bit more future-proof than the previous theme, with certain screens featuring more prominent use of backend Lua code to replace legacy methods of rendering particular elements.
Lambda Rebuild is an update to the Lambda theme that shipped with StepMania 5.1 Beta 2, designed specifically for StepMania 5.3.

Progress
-----------
This requires 5.3
Why did I suddenly revisit it? Although it looked nice, it was an absolute mess in reality due to a combination of rookie mistakes,, types of code we are trying to deprecate moving forward (particularly, cmd blocks in Lua scripts), and the state of StepMania itself at the time (5.3 is pretty much night and day in comparison, so far). During the early stages of 5.3 development, I had a version of Lambda we were using as a temporary theme until Soundwaves was usable.

At one point, we had went through and removed all use of cmd, but 720p themes still didn't run nearly as good as Simply Love on these early builds (our main metric is uncapped frame rate). I randomly decided to load said version of Lambda into a current build, and it actually performed on par with Soundwaves. However, I did have to do some tweaks to make it work with the present implementations of certain features, and then this escalated into me actually doing some stylistic tweaks (since I had to re-create the old color scheme due to this version originally having a dark blue and dark gold color scheme), freshening up the typography, and so on.

Source code
-----------
Inkscape SVG source code is available for the majority of graphics created in the _src folder on the repository used to develop it, located at <https://github.com/ListenerJubatus/smtheme-fiftyOne> Some of the original mockups are also included for reference, although they are meant primarily for reference purposes due to changes in the theme's style since these mockups (such as the removal of rounded corners and increased use of chamfered edges and diamond motifs).

The main fonts are the current version of Roboto and Noto Sans <https://www.google.com/design/spec/resources/roboto-noto-fonts.html>, and Open Sans (although, preferably, Noto Sans should eventually be used in any location Open Sans is currently used). Certain accents make use of the fonts Overpass <http://overpassfont.org/> and Zeroes <http://www.dafont.com/zero-threes.font>
# License
## Lambda
As it incorporates existing code from StepMania, and is intended to possibly be part of the main distribution, Lambda is licensed under the terms of the MIT License. This applies to code committed prior to the creation of Lambda Rebuild.

All new code (including code re-used from StepMania 5.3) is additionally licensed under the Apache License 2.0

License
-----------
As it incorporates existing code from StepMania, and is intended to possibly be part of the main distribution, Lambda is licensed under the terms of the MIT License.
## Code from Soundwaves
Copyright 2019 Team Rizu contributors

All newly-created code is licensed under the Apache License 2.0 (the License).
You may not use these files except in compliance with the License.

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

0 comments on commit fc91ab0

Please sign in to comment.