Cool_Tools/bemani-guide
1
0
Fork 0
mirror of https://github.com/yxrei/bemani-guide.git synced 2024-11-23 22:41:03 +01:00
Code Releases Activity

Delete obsolete pages

Browse Source
This commit is contained in:
yurei 2024-06-05 13:30:53 +02:00
parent b066059eea
commit f9e9fa90f6
6 changed files with 1 additions and 442 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

178
docs/changelog.md
View File

@ -1,178 +0,0 @@
# Changelog
### What's New:
!!! tip "November 11th, 2023"
- Fix an inconsistency in setups for IIDX 9 to IIDX 13
!!! tip "September 30th, 2023"
- Add IIDX 13 setup & faq
!!! tip "September 19th, 2023"
- Add IIDX 11 setup & faq
- Add IIDX 12 setup & faq
- More clean ups of IIDX 9 & IIDX 10
- Adjust navigation bar text for IIDX and SDVX
- Adjust SDVX game names on their pages
!!! tip "September 17th, 2023"
- Add IIDX 10 setup & faq
- Clean up IIDX 9 setup & faq (mainly the codec installation)
- Removed [Btools] notice on the navigation bar
!!! tip "September 15th, 2023"
- Add IIDX 9 setup & faq
- Clean up IIDX 24: SINOBUZ setup & faq
- Removed contact section from the about page
- Add Discord to Home page
- Adjust Home page text to also include Bemanitools
!!! tip "September 11th, 2023"
- Add IIDX 24: SINOBUZ setup/faq/hex edits
- Updated the hex edits pages of all games
- Add logo and favicon
- Add logo for every IIDX and SDVX game for each of their respective pages
!!! tip "September 10th, 2023"
- Changed the theme
- Made the project open source
!!! tip "August 30th, 2023"
- Revive the project
- Updated the contact and about section
 
!!! tip "April 8th, 2021"
- Added Hello Pop'n Music Guide
- Added Pop'n Peace guide
- Various fixes and error code improvements for IIDX
- Added new guide to extras section: Exclusive Audio Workarounds
!!! tip "March 24th, 2021"
- Added Nostalgia Op. 2 guide
- Updated Forte guide
- Added more external resources
!!! tip "March 21st, 2021"
- Added misc small improvements
- Added jubeat rubber part information (Immense delay on this, apologies)
- Added information about VW final hex edits
!!! tip "December 21st, 2020"
- HTTPS fixed
- robots.txt changes
- Cleaned up some Heroic Verse related content
- Actually updated content I said I would update 2 months ago (sorry!)
!!! tip "October 27th, 2020"
- Added IIDX 27: Heroic Verse setup/faq/etc
!!! tip "July 27th, 2020"
- Updated Arcade Parts List
- Added an External Resources Section (sorry for delay to those that submitted resources, busy time)
- Updates to all main guides/SpiceTools coming soon.
!!! tip "April 23rd, 2020"
- Added some minor info about WASAPI shared mode for SDVX V
!!! tip "April 11th, 2020"
- Adjusted some troubleshooting
- Added user contributed polling rate
- Misc bits and pieces
!!! tip "April 1st, 2020"
- Added SDVX V guides
!!! tip "March 14th, 2020"
- Site back online (hello everyone)
- Pop'n Usaneko setup/faq/hex edits
- Spice pages updated
!!! tip "March 11th, 2020"
- Formatting fixes for hex edits
- Minor tinkering with ASC/Parts sections
- DDR Ace cleanup
- Museca cleanup + faq/hex edits
- Beatstream cleanup
- Misc changes
!!! tip "March 10th, 2020"
- Add DDR ACE setup/faq/hex edits
- Add IIDX 26: ROOTAGE setup/faq/hex edits
- Additional cleanup
!!! tip "March 7th, 2020"
- Add GITADORA EXCHAIN setup/faq/hex edits
!!! tip "March 6th, 2020"
- Add Parts Documentation
- Add to part considerations to ASC section
- CSS changes, formatting, cleanup
 
!!! tip "March 5th, 2020"
- Revive project (sorry it was dead for so long!)

55
docs/extras/spiceerrors.md
View File

@ -1,55 +0,0 @@
# SpiceTools Error Messages
!!! warning "Before reading:"
This section contains common errors that users may come across when utilizing SpiceTools that DO NOT pertain to [Error Codes.](/errorcodes/) While it's virtually impossible to write on every solution for every error, there's a small handful that arise from time to time. Consider this one of the weaker sections on the site due to the infinitely varying amounts of hardware and game-specific problems that may arise. Nonetheless, this section may be helpful as a last resort or for overly specific issues. Errors are listed in potpourri fashion with game specific notes inside said sections as applicable.
### Initial Checklist
!!! tip ""
There's always a couple quick things to check before even running SpiceTools, namely...
- Your data comes from a clean and trusted source, ideally unmodified.
- You are not currently seeding your data and it's not already opened.
- You have specified within Windows that SpiceTools should be ran as an administrator.
- You're using the latest SpiceTools
- You've correctly followed the `First Time Setup` and `Common Problems/Tips` section of your desired game and your `.bat` file contains no errors.
### Failed to Read /dev/nvram/coin.xml.
!!! tip ""
Copy `coin.xml` from `prop` to `dev/nvram` or alternatively, update to a SpiceTools as new as 03/04/2020 or later.
### Failed to Read /dev/nvram/eacoin.xml.
!!! tip ""
Copy `eacoin.xml` from `prop` to `dev/nvram` or alternatively, update to a SpiceTools as new as 03/04/2020 or later.
### Cannot create property: prop/ea3-config.xml
!!! tip ""
Firstly make sure your `ea3-config.xml` is clean and that it is not set to `Read-only`.
If it's been modified, common problems that might arise may be having `https` under `<services __type="str">urlhere</services>` or anywhere else a custom services URL has been added. Use `http` instead.
Don't use notepad when modifying any of the .xml files, it can break the encoding and cause issues.
Ideally just use SpiceTools `-url` and `-p` parameters to avoid modifying this file in most use cases.
### XYZ Couldn't be loaded: Specified module cannot be found.
!!! tip ""
Firstly, make sure what is attempting to load is indeed present.
If the file is `libavs-win64.dll` then you're using 64-bit SpiceTools when the game is 32-bit, please switch to 32-bit instead. SpiceTools should also tell you do this!
However, more often than not this error is more the user missing specific dependencies. Below are the most common ones that are missing on a fresh installation or older hardware.
- [Microsoft Visual C++ 2010 Redistributable Package (x64)](https://www.microsoft.com/en-us/download/confirmation.aspx?id=14632)
- [DirectX 9.0c End-User Runtime](https://www.microsoft.com/en-us/download/details.aspx?id=34429)
### Crashing Upon Startup
!!! tip ""
This issue has numerous reasons all pertaining to the user, most commonly the game is not able to run at its specified resolution, say a game requiring portrait mode while running in landscape for example. This might also occur if installation was not done properly, or key files are missing as well.
SpiceTools does a good job documenting what errors are occurring, make sure to read near the bottom of `log.txt` after a crash to try and better understand what might be wrong.

199
docs/extras/spiceguide.md
View File

@ -1,199 +0,0 @@
# SpiceTools Usage, Parameters, and Functionality
- **Last Update: March 14th, 2020.**
- **Version Covered: March 3rd, 2020.**
!!! warning "Before reading:"
This section contains a myriad of information regarding SpiceTools including the games supported, various parameters, and its functionality. Feel free to consult this section anytime you are confused or simply want to learn more. However, SpiceTools is consistently updated and updates to this section may fall behind, to combat this, the above information in bold will cover the latest revision of SpiceTools this guide covers and along the latest update to this section.
### What is SpiceTools?
!!! tip ""
SpiceTools is a toolkit allowing users to play several BEMANI games on their PC, typically of the arcade variety with the focus being on BEMANI games. The idea behind SpiceTools is to provide a simple to use toolkit that consists of just the executable and its configuration, allowing users to have minimal interaction with game files and thus minimizing user error.
### Why SpiceTools
!!! tip ""
The reason this guide utilizes SpiceTools exclusively is because it's capable of running games without the user ever touching a single file, minimizes any potential user error. On top of this, SpiceTools has a few exclusive features that benefit new and experienced players alike. The combination of simplicity and advanced features makes it an ideal choice.
### SpiceOverlay
!!! tip ""
One of the newest features SpiceTools has is an included overlay called SpiceOverlay, it contains a number of useful options such as a patch manager to enable/disable patches on the fly, and virtual keypads, its keybinds are as follows below:
``F5 - Keypad P1``
``F6 - Keypad P2``
``F7 - Card Manager``
``F8 - Log``
``F9 - Control``
``F10 - Patch Manager``
``F12 - Overlay/FPS toggle``
### SpiceOptions
!!! tip ""
SpiceTools now features an options tab that allows you to set parameters inside the game with the ability to restart the game after you make your desired changes.
<img src="/img/spice/options.png">
Note that the purple highlighted options are tied to the specific game you are running, you do not need to check them in most cases as oftentimes they are loaded automatically for most setups.
### SpiceCompanion
!!! tip ""
SpiceTools also has a companion app on android called [SpiceCompanion](https://play.google.com/store/apps/details?id=spicedev.spicecompanion) this guide won't go over all of its features and functionalities, perhaps a separate page would be more appropriate. Just note it shares many similarities with SpiceOverlay and is yet another powerful tool to aid in playing these arcade games. One fan favorite feature is the ability to utilize your phone as a card reader, allowing friends to easily card-in and play alongside you.
### Supported Games
!!! tip ""
SpiceTools at the time of writing supports the following games, if no specific denotation is listed, assume all recent versions of said game):
- beatmania IIDX (Tricoro and newer)
- Sound Voltex
- jubeat (knit and newer)
- Reflec Beat
- Dance Evolution Arcade
- DanceDanceRevolution
- Beatstream
- Road Fighters 3D
- Pop'n Music
- MÚSECA
- Metal Gear Arcade
- GITADORA (XG3 and newer)
- NOSTALGIA
- BISHI BASHI CHANNEL
- QUIZ MAGIC ACADEMY
- MAHJONG FIGHT CLUB
- FutureTomTom
- SCOTTO
- HELLO! Pop'n Music
- LovePlus
- DANCERUSH STARDOM
- Steel Chronicle
- Tenkaichi Shogikai
- Otoca D'or
- Winning Eleven 2012
### Coins
!!! tip ""
There's a coin emulation working for most games, simply press F1 to insert a single coin.
Some games have an additional/different coin key.
### Readers
!!! tip ""
If you have an original Wavepass reader and have it connected to a COM port on your computer, SpiceTools should be able to use it. It was being created and tested with the newer readers also used in the newer Pop'n Music games.
Example for one reader on COM3: -reader COM3
Example for two readers for P1/2 on COM3 and COM4: -reader COM3 -reader COM4
Example for one reader with P1/2 toggle on NumLock: -togglereader COM3
### SpiceTools API
!!! tip ""
SpiceTools has its own API with a custom protocol. The main goals were simplicity, portability and extensibility, so TCP/JSON was chosen, allowing fast access over network.
It optionally supports passwords/encryption and its response time on LAN was tested to be below 1ms (as long as extended API logging isn't enabled manually).
For details and how to use it, check out README.md in the included source. Additionally, python and dart libraries are provided for easy communication.
Key features are card/coin insertions, read/write access for keypads/analogs/buttons/lights, status information and memory read/write via raw addresses and signatures.
### Bemanitools 5 API Compatibility
!!! tip ""
There is basic BT5 API integration as of 03/13/2018.
This feature can be enabled with `-bt5api` and currently makes use of eamio.dll only.
Currently, this can be used for applications such as the popular NFCeamuse app which can be found elsewhere.
### Keybindings/Analogs
!!! tip ""
As of beta, buttons can be bound via either RawInput (the default) or "Naive" (GetAsyncKeyState).
RawInput supports all kinds of HID controllers (your FP7 is one, your XBOX360 Controller as well), however it's bound to a device.
If you plug your controller into another USB slot, SpiceTools does not have a way to detect it and will report the device as "missing", until you plug it back into where you originally configured it.
Using the "naive" approach, only keyboard buttons can be detected, however this will then work with any keyboard attached, it's not bound to a device.
Since May 2018 you can also bind MIDI devices for "one-shot" types like drums and hold types like piano keys and launchpads.
### Usage
!!! tip ""
Utilizing SpiceTools is very straightforward, it typically involves simply dropping SpiceTools 32-bit or 64-bit (depending on game requirements) into your chosen game's content folder, creating a `.bat` file that initializes SpiceTools and desired parameters. For the grand majority of user installations, I've documented how to best utilize SpiceTools in the first time setup section of your respective game, so please read over it. One of the easiest and classic examples of a `.bat` file's contents would be along the lines of `spice64.exe -ea -w` which would boot SpiceTools with the `-ea` and `-w` parameters, more on parameters below.
### Parameters
!!! tip ""
SpiceTools consists of several dozen parameters for users to utilize to fill their needs. Ideally, these parameters are initialized using a user created `.bat` file as described above. If you open up `spicecfg.exe` and head on over to the options tab, you can hover over the far left `?` with your mouse to get an idea as to what a parameter does!
The grand majority of parameters are for advanced users, but don't be scared if you don't understand what most do.
&nbsp;
## Notes on Functionality for Several Games
### beatmania IIDX
!!! tip ""
For using your own cameras in IIDX 25 or newer, just plug them in (and hopefully your camera isn't incompatible with the game) and they shall work.
It's also possible to use one camera only instead of the two the game wants, just dismiss the camera error on game boot as you would with no cameras connected, and your camera should be registered in-game as CAMERA A. If you're not happy with the order of the automatic camera detection, just use -iidxflipcams and CAMERA B will be CAMERA A, etc.
You can bind the effectors as analog inputs if you want, this is especially interesting for IIDX 25 and newer, where the effects are software based and not tied to specific sound cards anymore. When not bound, they will stay on the maximum value.
### Sound Voltex
!!! tip ""
Printer fully supported as of 03/13/2018, can save prints in PNG/BMP/TGA to a customizable output path.
Optionally able to clean up saved images on game boot time.
Keyboard play should be perfectly working. If you don't want to use the mouse for the knobs, you can make use of native knob emulation, which works just as it works in Keyshoot-Mania.
### jubeat
!!! tip ""
This makes use of the SpiceTools touch module, which makes you able to play any version of the game just fine with both mouse and HID compliant touch devices on Windows 7 or newer.
The Dell ST2240T touch screen seems to work well, especially the new 2017 revision.
Card insert button available and enabled by default.
Touch the area to insert a card in attract mode.
### GITADORA
!!! tip ""
To switch between Guitar/Drum you need to specify the specific eamuse config to load. By default, SpiceTools first tries to load ea3-config.xml, then eamuse-config.xml.
Since the latter one is the default for the drums, for the guitar you have to override the path setting like so: `spice64.exe -e prop\eamuse-config2.xml`
Additionally, since GitaDora uses 4 channels by default, you can specify -2ch to run it with 2 channel audio instead. If you don't and have a normal 2 channel setup, the game will refuse to play sound/tracks.
### Reflec Beat
!!! tip ""
Including emulation of the real IR touch screen device so the game should just act like the real one.
This makes use of the SpiceTools Touch module, which makes you able to play any version of the game just fine with both mouse and HID compliant touch devices.
Card insert button available and enabled by default.
For this game it's not visible in fullscreen but still works just as fine.
Touch the area to insert a card in attract mode.
### NOSTALGIA
!!! tip ""
Spicetools will auto-detect whether or not a compatible touch device is present. If a touch device is detected, the mouse cursor will disappear. If no touch device is detected, the mouse cursor will be visible in-game. During boot-up process, do not click or else the game may pre-maturely crash. You may safely click after the monitor check is completed. It's been found that Virtual HID Touch devices commonly found with remote access software may cause detection issues, take note of that.
Some people have had issues with crashing on startup while having multiple monitors while using windowed mode, consider disabling the other monitors to see if this alleviates the issue.

2
docs/index.md
View File

@ -13,7 +13,7 @@ description: A compendium of information and guides written to ease headaches.
A compendium of information and guides written to ease headaches.
Last updated: May 12th, 2024
Last updated: June 5th, 2024
Changelogs will posted on the Discord in detail.

7
docs/secret.md
View File

@ -1,7 +0,0 @@
# Secret
This is a secret page! I cover more savory topics I am not comfortable having public links to here. If you came across this page, out of respect I would appreciate you not plastering it everywhere public.
To be populated with time.
&nbsp;

2
mkdocs.yml
View File

@ -118,8 +118,6 @@ nav:
- 'How to setup Asphyxia CORE': 'extras/asphyxia.md'
- 'Notes on the Most Common ASCs and Vendors': 'extras/ascs.md'
- 'Arcade Parts List and Documentation': 'extras/parts.md'
- 'SpiceTools Usage, Parameters, and Functionality': 'extras/spiceguide.md'
- 'SpiceTools Error Messages': 'extras/spiceerrors.md'
- 'List of Touchscreen Monitors and their Polling Rates': 'extras/pollingrates.md'
- 'What is WASAPI and ASIO?': 'extras/audio.md'
- 'Exclusive Audio Workarounds': 'extras/streamaudio.md'