Skip to content

Commit

Permalink
updates
Browse files Browse the repository at this point in the history
  • Loading branch information
Scraticus committed Sep 17, 2023
1 parent 2ddfe35 commit 2de6dab
Show file tree
Hide file tree
Showing 12 changed files with 69 additions and 17 deletions.
7 changes: 5 additions & 2 deletions content/dev/mode-support/tja-support.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ geekdocCollapseSection: true

Project OutFox is working on support on the parser for the TJA (Taikojiro) chart format, which is the standard format used in conjunction with the ``taiko`` game types. The following page contains details on the Taiko parsing options that Project OutFox currently supports. This is a living document - it will be incomplete as Squirrel finds time to update and confirm/clarify items that are missing or unknown.

## TJA Notedata support as of Alpha 4.14.0 - ``Partial``!
## TJA Notedata support as of Alpha 4.19.0 - ``60% Complete``!
---
## Headers
---
Expand Down Expand Up @@ -81,7 +81,7 @@ This header sets the file name of the song you wish to play. You do need to bear
>* ``OPUS``
>* ``FLAC``
This header is similar to the ``#WAVzz`` header used in BMS, except we're only calling the one for this mode. Do ensure your file is encoded to 44.1kHz (44,100) as some older OGG encoders can do weird things to your file. If you're ever unsure, use the program MediaInfo which is a handy little program for mediafile information. Most simulators will not play bad or slightly corrupted files, so this is something to take into consideration when creating your chart, so take a moment to check the file is good.
This header is similar to the ``#WAVzz`` header used in BMS, except we're only calling the one for this mode. Do ensure your file is encoded to 44.1kHz (44,100) as some older OGG encoders can do weird things to your file. If you're ever unsure, use the program MediaInfo which is a handy little program for media file information. Most simulators will not play bad or slightly corrupted files, so this is something to take into consideration when creating your chart, so take a moment to check the file is good.

Example
```
Expand Down Expand Up @@ -310,4 +310,7 @@ The table below shows the 'alternative' note types used by the bongo mode. These
>* ``I`` = Yellow Left Roll - Ends with an ``8`` (Proposed)




_Written and Maintained with ♡ by Squirrel, with thanks to OpenTaiko, Taiko-web, and members of the TJADB and Taiko international community_
4 changes: 2 additions & 2 deletions content/user-guide/games/bemu.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,9 +148,9 @@ The original PSX/PS2 era controllers can be unusually difficult to use, so be mi

## Trivia

BMS charts originally were used for DDR and SOLO mapping in 1999 for dance style simulations, and had some obscure channel mapping long since lost to the known world - (no-one uses this older methodology anymore). However, the notesloaders can still load the common layouts, when the BMS load was expanded, it was decided to keep this legacy in the code. This functionality was broken for a short time in alpha 4.12 and restored in 4.15 due to Squirrel making an oopsie.
BMS charts originally were used for DDR and SOLO mapping in 1999 for dance style simulations, and had some obscure channel mapping long since lost to the known world - (no-one uses this older methodology anymore). However, the notes-loaders can still load the common layouts, when the BMS load was expanded, it was decided to keep this legacy in the code. This functionality was broken for a short time in alpha 4.12 and restored in 4.15 due to Squirrel making an oopsie.

``be-mu`` once incorporated loadng all of the BMS type charts, including PMS, this unfortuanately caused a lot of charts to break and not load correctly in older builds of SM5 so this behaviour was removed.
``be-mu`` once incorporated loading all of the BMS type charts, including PMS, this unfortunately caused a lot of charts to break and not load correctly in older builds of SM5 so this behaviour was removed.

The old ``kb7`` mode used a custom channel methodology built into BMS in the early SSC builds. This behaviour was also maintained in the rewrite so those old charts work, however the mode style is different in _Project OutFox_ now.

Expand Down
4 changes: 3 additions & 1 deletion content/user-guide/games/dance.md
Original file line number Diff line number Diff line change
Expand Up @@ -138,4 +138,6 @@ _Project OutFox_ added ``double`` and ``versus`` modes to solo and threepanel at

## Controls

## Trivia
## Trivia

_Written and Maintained with ♡ by Squirrel_
10 changes: 6 additions & 4 deletions content/user-guide/games/ez2d.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,10 +47,10 @@ Replaced by:

**Removed:**

* ~~StepMania v3.0 beta 6 - ``(singleHard)`` (29 September 2002)~~
* ~~StepMania v3.0 beta 6 - ``(versusHard)`` (29 September 2002)~~
* StepMania v3.0 beta 6 - ``(singleHard)`` (29 September 2002)
* StepMania v3.0 beta 6 - ``(versusHard)`` (29 September 2002)

Replaced by:
Renamed:
* OutFox Alpha 4.10.0 - ``(ez2d)`` (23 September 2021)


Expand All @@ -71,4 +71,6 @@ Replaced by:

## Controls

## Trivia
## Trivia

_Written and Maintained with ♡ by Squirrel_
2 changes: 2 additions & 0 deletions content/user-guide/games/gdgf.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,3 +73,5 @@ Replaced with:
## Controls

## Trivia

_Written and Maintained with ♡ by Squirrel_
11 changes: 11 additions & 0 deletions content/user-guide/games/gh.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,15 @@ First Seen:
Replaced by:
* Project OutFox alpha 4.9.7.2 - ``(solo-versus6)`` (26 March 2021) (renamed from ``group6``)

## Supported Parser Types:
This mode is _parser specific_. It will only load and parse items designed for the `gh` series of simulations.

The table below lists the supported files and their types that ``gh`` supports, their key/button value and the original mode the parser is used for (if any).

File Type|Label|Original Mode|Key Values Supported|Notes
------------|-------------|-------------|-------------|-------------|
``.chart`` | CHART | ``gh`` | easy/normal/pro | parser based on the 'gh' era up until around 2014.
``.midi`` | MIDI | ``gh`` | easy/normal/normal5/pro |

## Gameplay

Expand All @@ -69,3 +78,5 @@ Replaced by:
## Controls

## Trivia

_Written and Maintained with ♡ by Squirrel_
2 changes: 1 addition & 1 deletion content/user-guide/games/kbx.md
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ File Type|Label|Original Mode|Key Values Supported|Notes
``.sm/.ssc`` | SM | ``dance`` / ``pump`` / ``para`` / ``techno`` / ``smx`` / ``ds3ddx`` / ``maniax`` / ``ez2`` | 3k / 4k / 5k / 6k / 8k / 9k / 10k / 12k / 16k / 18k | main format of _stepmania_ covering a lot of game types and lanes
``.tja`` | TJA | ``taitai`` | 1k | _taikojira_ charts

This mode needs no _autogen_ to be configured! There is a setting in the preferences that enables or disables the precaching when the game loads.
This mode needs no _autogen_ to be configured! There is a setting in the preferences that enables or disables the pre-caching when the game loads.

---
## Game play
Expand Down
2 changes: 2 additions & 0 deletions content/user-guide/games/kickbox.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,3 +50,5 @@ First Seen:
## Controls

## Trivia

_Written and Maintained with ♡ by Squirrel_
4 changes: 3 additions & 1 deletion content/user-guide/games/maniax.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,6 @@ First Seen:

## Controls

## Trivia
## Trivia

_Written and Maintained with ♡ by Squirrel_
20 changes: 18 additions & 2 deletions content/user-guide/games/smx.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,21 @@ weight: 2

## History:

This mode was added towards the end of the alpha 4 development cycle of _Project OutFox_ at the end of 2021. It is a simulation of the game _StepManiaX_ by StepRevolution, and was created with their blessing.
This mode was re-added towards the end of the alpha 4 development cycle of _Project OutFox_ at the end of 2021. It is a simulation of the game _StepManiaX_ by StepRevolution, and was created with their blessing. It began life on our original base development back in 2018, when the project was codenamed _FoxMania_.

### Introduced:

### Introduced (FoxMania):
#### 5 Sensor (L/U/C/R/D):

First Seen:
* FoxMania 1b - ``(single)`` (10 April 2018)
* FoxMania 1b - ``(double6)`` (10 April 2018)
* FoxMania 1b - ``(double10)`` (10 April 2018)
* FoxMania 1b - ``(couple)`` (10 April 2018)
* FoxMania 1b - ``(routine)`` (10 April 2018)
**Lost**

### Introduced (Project OutFox):
#### 5 Sensor (L/U/C/R/D):

First Seen:
Expand Down Expand Up @@ -47,3 +59,7 @@ First Seen:
## Trivia

This game module will not support the special timing methodology that is used in the arcade version due to a limitation in the software, and will not support any official 'data' from the sim-files used in the original game.

Due to a massive corruption issue on the gitlab server that hosted our work, we lost several months of development time, and had to restart the project when we were still using the _FoxMania_ codename. The version written back then does not reflect the current implementation, so it has to be considered replaced.

_Written and Maintained with ♡ by Squirrel_
1 change: 1 addition & 0 deletions content/user-guide/games/stepstage.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,3 +41,4 @@ First Seen:

## Trivia

_Written and Maintained with ♡ by Squirrel_
19 changes: 15 additions & 4 deletions content/user-guide/games/taiko.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,22 @@ insert picture of gameplay

## History:

This mode was added in alpha 4.9.9HF of _Project OutFox_. In its' original form, it was a five-column mode with each note type having its' own column. Later, within the same alpha (July 11 2021), it was redone to have the notes be different note types instead of notes in columns, with only one column being needed.
This mode was re-added in alpha 4.9.9HF of _Project OutFox_. In its' original form, it was a five-column mode with each note type having its' own column. Later, within the same alpha (July 11 2021), it was redone to have the notes be different note types instead of notes in columns, with only one column being needed.

In this mode the parser support for the mode is being actively developed, and the chart support will be aligned with other taiko based simulators to provide parity and coherence for the community. We can parse .osu/.osz (Mode 1 taiko) and .tja files, although some of the scroll and time signature math needs to be concluded. As of alpha 4.15 the parsers are about 60% complete.

This mode is selectable in the game select screen.

### Introduced:
It began life on our original base development back in 2018, when the project was codenamed _FoxMania_.

### Introduced (FoxMania):
#### Drum (LeftOuter, LeftInner, RightInner, RightOuter):

First Seen:
* FoxMania 1c - ``(taitai-single)`` (15 April 2018)
**Lost**

### Introduced (Project OutFox):
#### Drum (LeftOuter, LeftInner, RightInner, RightOuter):

First Seen:
Expand Down Expand Up @@ -81,12 +90,14 @@ There are also notes which need to be hit a certain amount within a set time.

## Trivia

This mode had a prototype back in _FoxMania_ in the early days of the project (Pre Alpha 1).

It is the first horizontal scroll game we support in _Project OutFox_.

This mode also introduced the concept of 'count holds'. This is effectively to set how the counted hit notes (balloons) are measured and scored.

This mode introduced the concept of a non-tick/non-beat based roll hold, which needed a lot of new code added to _Outfox_ to implement.

This mode had a prototype back in _FoxMania_ in the early days of the project (Pre Alpha 1).

Due to a massive corruption issue on the gitlab server that hosted our work, we lost several months of development time, and had to restart the project when we were still using the _FoxMania_ codename. The version written back then does not reflect the current implementation, so it has to be considered replaced.

_Written and Maintained with ♡ by Squirrel_

0 comments on commit 2de6dab

Please sign in to comment.