Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
kphoenix137 committed Aug 20, 2024
1 parent 439ddb5 commit f8f8208
Showing 1 changed file with 35 additions and 17 deletions.
52 changes: 35 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Diablo MapGen is a tool designed to analyze maps generated in the game Diablo I

## Features

- Analyzes Diablo I maps to identify optimal seed candidates.
- Analyzes Diablo 1 maps to identify optimal seed candidates.
- Considers factors such as map layout, item distribution, and quest placement.
- Designed to assist speedrunners in achieving faster completion times.

Expand Down Expand Up @@ -43,29 +43,45 @@ As an example, you can run the following command to scan for seeds where Naj's P
./diablo-mapgen --scanner item --target 9 --targetStr "Naj's Puzzler" --start 315532800 --count 1864050846
```

### Options
## Options

- `--ascii`: Print ASCII version of levels.
- `--export`: Export levels as .dun files.
- `--scanner <type>`: How to analyze levels. Available options:
- `none`: No analysis (default).
- `warp`: Find seeds with a warp on level 15.
- `path`: Estimate the time to complete the levels, skip seeds that take longer then number of secound specified by `--target`.
- `warp`: Find seeds with a Lazarus warp on level 15.
- `path`: Estimate the time to complete the levels.
- `target`: The time (in seconds) to complete the levels to skip seeds that take longer.
- `stairs`: Look for stairs with a very short distance between them.
- `pattern`: Search for levels specified by `--target` (default blank) based on tile patterns and print out there level seed.
- `gameseed`: Search for GameSeeds that generates the LevelSeed given by `--target` (default 9:3916317768).
- `item`: Search for items on the level specified by `--target` (default [Scan Every Dlvl]), using item name string specified by `--targetStr`.
- `--start <offset>`: The seed to start from.
- `--count <number_of_seeds>`: The number of seeds to process.
- `--seeds <file>`: A file to read seeds from rather then using a sequental range.
- `--target <value>`: A target value to set for the scanner (level, time, or seed).
- `pattern`: Search for Level Seeds based on tile patterns.
- `target`: The dungeon level to search for.
- `gameseed`: Search for Game Seeds that generate a specified Level Seed (default 9:3916317768).
- `target`: The Level Seed to search for.
- `item`: Search for items on a dungeon level (default 0).
- `target`: The dungeon level, 0-16 (Note: 0 is used to scan every dungeon level).
- `targetStr`: The item name string to search for.

### Game Seed Options

- `--start <offset>`: The Game Seed to start from.
- `--count <number_of_seeds>`: The number of Game Seeds to process.
- `--seeds <file>`: A file to read Game Seeds from rather then using a sequental range.

### Game Logic Options

- `--mp`: Runs game logic in multiplayer mode.

### Information Options

- `--quiet`: Do not print progress messages.
- `--verbose`: Print out details about seeds.
- `--verbose`: Print out extra details about scans.

### Output Options

### Seed Filtering Strategy
- `--ascii`: Print ASCII version of levels.
- `--export`: Export levels as .dun files.

To efficiently analyze seeds start by using the `warp`, or `puzzler` options to quickly filter out seeds based on their criteria. Save the filtered results using the `>` operator to a file for use with the next analyzer. For example:
## Seed Filtering Strategy

To efficiently analyze seeds start by using the `warp`, or `item` options to quickly filter out seeds based on their criteria. Save the filtered results using the `>` operator to a file for use with the next analyzer. For example:

```
./diablo-mapgen --scanner warp --start 315532800 --count 1864050846 > filtered_seeds.txt
Expand Down Expand Up @@ -93,9 +109,11 @@ This command splits up the seed range between processes concurrently. You can ad

- `--scanner <type>`: How to analyze levels (default pattern).
- `--target <value>`: A target value to set for the scanner (level, time, or seed).
- `--targetStr <string>:` A target string to set for the scanner (item name).
- `--start <offset>`: The seed to start from.
- `--count <number_of_seeds>`: The number of seeds to process.
- `--threads <number_of_processes>`: The number of concurrent processes (default is one less then CPU threads)
- `--threads <number_of_processes>`: The number of concurrent processes (default is one less then CPU threads).
- `--mp`: Runs game logic in multiplayer mode.

## Terminology

Expand Down

0 comments on commit f8f8208

Please sign in to comment.