Skip to content

Commit

Permalink
Improve README
Browse files Browse the repository at this point in the history
  • Loading branch information
heinermann committed Mar 10, 2024
1 parent 76f19d8 commit 8f79b7a
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 9 deletions.
3 changes: 2 additions & 1 deletion BOLT/bolt-extract/main.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ void configure(cxxopts::Options& cmd) {
cmd.add_options()
("i,input", "input file", cxxopts::value<std::string>())
("b,big", "Use Big Endian byte order (N64, CD-i)")
("a,algo", "Choose algorithm to use.", cxxopts::value<std::string>()->default_value(""), "cdi|dos|n64|gba|win|xbox")
("a,algo", "Choose algorithm to use.", cxxopts::value<std::string>()->default_value(""), "cdi|dos|n64|gba|win|xbox|ps2")
("o,output", "output directory (optional, defaults to input file's directory)", cxxopts::value<std::string>())
("h,help", "show help")
;
Expand Down Expand Up @@ -45,6 +45,7 @@ std::map<std::string, BOLT::algorithm_t> algorithm_mappings = {
{"win", BOLT::algorithm_t::WIN},
{"windows", BOLT::algorithm_t::WIN},
{"xbox", BOLT::algorithm_t::XBOX},
{"ps2", BOLT::algorithm_t::XBOX},
};

BOLT::algorithm_t determine_algorithm(const std::filesystem::path &input_file, std::string algorithm) {
Expand Down
15 changes: 7 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Here are some games confirmed to use BOLT archives:
- 3-D TableSports (DOS)
- The Game of Life (Windows 95)
- Bassmasters 2000 (N64)
- Namco Museum (N64, GBA, Dreamcast)
- Namco Museum (N64, GBA, Dreamcast, PS2, XBox)
- Ms. Pac-Man - Maze Madness (N64, Dreamcast)
- Power Rangers - Lightspeed Rescue (N64)
- **Starcraft 64** (N64)
Expand All @@ -28,20 +28,19 @@ Usage:
bolt-extract [OPTION...] INPUT_FILE [OUTPUT_DIR]
-b, --big Use Big Endian byte order (N64, CD-i)
-a, --algo cdi|dos|n64|gba|win|xbox
-a, --algo cdi|dos|n64|gba|win|xbox|ps2
Choose algorithm to use. (default: "")
-h, --help show help
```

Example: `bolt-extract.exe -a n64 -b "StarCraft 64 (U).z64" starcraft64/`

## Supported Algorithms
- `n64` - Archive in z64 rom.
- `gba` - Archive in gba rom.
- `dos` - Archive either from MSDOS game or CD-i game.
- `cdi` - Archive for some older CD-i games.
- `win` - Archive for Windows game.
- `xbox` - Archive for XBOX game.
- `cdi` - For some older CD-i games before 1993.
- `dos` - Either from MSDOS or CD-i games between 1993 and 1996.
- `win` - For The Game of Life (1998).
- `n64`/`gba` - Used in games released between 1999 and 2003. You may need to manually separate BOLT archives in gba roms.
- `xbox`/`ps2` - Same as the n64 algorithm but with altered data structures. Used in games released from 2004 onward.

## Notes
- Only `z64` format roms for N64 are supported.
Expand Down

0 comments on commit 8f79b7a

Please sign in to comment.