# ๐ฐ Damdara ๐ฆ
<p align="center">
<img width="450" src="https://raw.githubusercontent.com/retrodig/damdara/main/assets/images/main_logo_cmp.png">
</p>
Damdara is a logic crate for retro fantasy that can be built in Rust, while fully reproducing the "Fukkatsu no Jumon"
system of the NES version of Dragon Quest,
Damdara is a logic crate for retro-fantasy, which can be built in Rust for elements such as status generation based on
the player's name, item equipping, and battle processing.
## Table of Contents
- [Features](#features)
- [Installation](#installation)
- [Cargo](#cargo)
- [Brew](#brew)
- [Usage](#usage)
- [Mode](#mode)
- [Status Option](#status-option)
- [Format Option](#format-option)
- [Additional Resources](#additional-resources)
- [Contributing to Damdara](#contributing-to-Damdara)
- [References](#references)
- [License](#license)
- [Author](#author)
## Features
- [x] Generate resurrection "Fukkatsu no Jumon" from parameters ๏ผParameters to Password๏ผ
- [x] Parameters generated from resurrection "Fukkatsu no Jumon" (Password to Parameters)
- [x] Calculate parameters enhanced by name
- [x] See list of monsters
- [x] Refer to any monster information
- [x] See parameter list
- [x] Refer to any parameter
- [x] See list of Item
- [x] Refer to any Item information
- [x] See list of Weapon
- [x] Refer to any Weapon information
- [x] See list of Armor
- [x] Refer to any Armor information
- [x] See list of Shield
- [x] Refer to any Shield information
- [ ] Reproduction of battle scenes
- [ ] See list of Town
- [ ] Refer to any Town information
- [ ] Refer to any World information
- [ ] See list of Message
- [ ] Explore the field
- [ ] Explore the Town
Bit configuration mapping table for password generation.
Byte Index | Field Description | Bits (from MSB to LSB)
------------|-------------------------------------------------|------------------------
0 | Checksum (CRC-8) | [7:0]
1 | Experience (lower 8 bits) | [7:0]
2 | Pattern[2] (1) + Necklace (1) + Name[2] (6) | [7], [6], [5:0]
3 | Item[3] + Item[2] | [7:4], [3:0]
4 | Gold (lower 8 bits) | [7:0]
5 | Name[0] (6) + Golem (1) + Pattern[1] (1) | [7:2], [1], [0]
6 | Item[7] + Item[6] | [7:4], [3:0]
7 | Pattern[0] + Dragon (1) + Name[3] (6) | [7], [6], [5:0]
8 | Weapon (3) + Armor (3) + Shield (2) | [7:5], [4:2], [1:0]
9 | Gold (upper 8 bits) | [7:0]
10 | Keys + Herbs | [7:4], [3:0]
11 | Item[5] + Item[4] | [7:4], [3:0]
12 | Experience (upper 8 bits) | [7:0]
13 | DragonScale (1) + Name[1] (6) + WarriorRing (1) | [7], [6:1], [0]
14 | Item[1] + Item[0] | [7:4], [3:0]
## Installation
### Cargo
```
cargo install damdara
```
**Add to project**
```
cargo add damdara
```
### Brew
```
brew tap webcyou-org/tap
brew install damdara
```
## Usage
```
cargo run <input>
```
or
```
damdara <input>
```
If input is not present, the default brave value is returned.
```
cargo run
player name: ใใใฆใ
summary: PlayerSummary { name: "ใใใฆใ", level: 1, hp: 15, mp: 3, gold: 0, experience: 0 }
strength_status: StrengthStatus { level: 1, strength: 4, agility: 6, max_hp: 15, max_mp: 3, attack_power: 4, defense_power: 3, weapon: "ใชใ", armor: "ใชใ", shield: "ใชใ" }
```
The name can be specified by giving -n
```
cargo run -- -n ใ ใ
player name: ใใใ
summary: PlayerSummary { name: "ใใใ\u{3000}", level: 1, hp: 14, mp: 0, gold: 0, experience: 0 }
strength_status: StrengthStatus { level: 1, strength: 4, agility: 4, max_hp: 14, max_mp: 0, attack_power: 4, defense_power: 2, weapon: "ใชใ", armor: "ใชใ", shield: "ใชใ" }
```
By granting options, you can change parameters, possess items, change equipment, and do many other things.
If you want to give 200 experience. The level is automatically reflected.
```
cargo run -- -n ใ ใ -e 200
player name: ใใใ
summary: PlayerSummary { name: "ใใใ\u{3000}", level: 5, hp: 32, mp: 20, gold: 0, experience: 200 }
strength_status: StrengthStatus { level: 5, strength: 11, agility: 10, max_hp: 32, max_mp: 20, attack_power: 11, defense_power: 5, weapon: "ใชใ", armor: "ใชใ", shield: "ใชใ" }
```
Furthermore, if you wish to grant 300 Gold.
```
cargo run -- -n ใ ใ -e 200 -g 300
player name: ใใใ
summary: PlayerSummary { name: "ใใใ\u{3000}", level: 5, hp: 32, mp: 20, gold: 300, experience: 200 }
strength_status: StrengthStatus { level: 5, strength: 11, agility: 10, max_hp: 32, max_mp: 20, attack_power: 11, defense_power: 5, weapon: "ใชใ", armor: "ใชใ", shield: "ใชใ" }
```
If you want to change the item possession, pass the corresponding item IDs separated by commas.
```
cargo run -- -n ใ ใ -i 2,3,4
player name: ใใใ
summary: PlayerSummary { name: "ใใใ\u{3000}", level: 1, hp: 14, mp: 0, gold: 0, experience: 0 }
strength_status: StrengthStatus { level: 1, strength: 4, agility: 4, max_hp: 14, max_mp: 0, attack_power: 4, defense_power: 2, weapon: "ใชใ", armor: "ใชใ", shield: "ใชใ" }
item: ["ใใใใ", "ใญใกใฉใฎใคใฐใ", "ใใ
ใใฎใใใ", "ใชใ", "ใชใ", "ใชใ", "ใชใ", "ใชใ"]
```
The equipment is also given an ID after specifying each option.
```
cargo run -- -n ใ ใ -w 3 -a 5 -s 3
summary: PlayerSummary { name: "ใใใ\u{3000}", level: 1, hp: 14, mp: 0, gold: 0, experience: 0 }
strength_status: StrengthStatus { level: 1, strength: 4, agility: 4, max_hp: 14, max_mp: 0, attack_power: 14, defense_power: 46, weapon: "ใฉใใฎใคใใ", armor: "ใฏใใญใฎใใใ", shield: "ใฟใใใฟใฎใใฆ" }
item: ["ใชใ", "ใชใ", "ใชใ", "ใชใ", "ใชใ", "ใชใ", "ใชใ", "ใชใ"]
```
`flags` are a group of flags that indicate whether a player has equipped a particular item or defeated a boss monster.
They can be specified collectively as a 5-digit bit string with the command line argument `--flags`.
```
cargo run -- -n ใ ใ --flags 01010
```
### List of CLI options
| option | type | default value | Description |
|:-------------------|:-------------------------|:------------------------------|:-----------------------------------------------|
| `-n`, `--name` | String | `"ใใใฆใ"` | Main character's name |
| `-e`, `--exp` | u16 | `0` | XP |
| `-g`, `--gold` | u16 | `0` | Gold in possession |
| `-w`, `--weapon` | u8 | `0` | The number of the weapon you are equipped with |
| `-a`, `--armor` | u8 | `0` | The number of the armor you are equipped with |
| `-s`, `--shield` | u8 | `0` | The number of the shield you are equipped with |
| `-i`, `--item` | Vec<u8>(comma delimited) | not in possession | List of item numbers |
| `-y`, `--herbs` | u8 | `0` | Number of herbs held |
| `-k`, `--keys` | u8 | `0` | Number of keys held |
| `--flags` | Flags structure | All false | status flag |
| `-p`, `--password` | String | Maximum Strengthened Password | Fukkatsu no Jumon |
### Flags option details๏ผ--flags๏ผ
| digit position | bit | Field Name | Description |
|:--------------:|:---:|:--------------------|:----------------------------------------|
| 1st digit | 0/1 | has_dragon_scale | Equipped with the scales of a dragon? |
| 2st digit | 0/1 | has_warrior_ring | Are you equipped with a warrior's ring? |
| 3st digit | 0/1 | has_cursed_necklace | Did you get the beak necklace? |
| 4st digit | 0/1 | defeated_dragon | You slayed the dragon. |
| 5st digit | 0/1 | defeated_golem | You beat the golem. |
- Specify with **5 digits 0/1** like `--flags 01000`.
- If not specified, default `โ00000โ` (all false)
### Mode
You can specify the mode by giving `--mode` or the shortcut `-m`.
```
cargo run -- --mode <input>
cargo run -- -m <input>
```
Mode Name | Description
-----------|-------------------------------------------------------------------------------|
start | Calculate enhanced parameters from name only |
save | Generate "Fukkatsu no Jumon" from arbitrary parameters (e.g. exp, gold, etc.) |
load | Restore name/parameters from the "Fukkatsu no Jumon" |
display | Supports list and individual display of master data |
**โ Start Mode**
Generate parameters from the names of brave men
**example**
```
player name: ใใใ
summary: PlayerSummary { name: "ใใใ\u{3000}", level: 1, hp: 14, mp: 0, gold: 0, experience: 0 }
strength_status: StrengthStatus { level: 1, strength: 4, agility: 4, max_hp: 14, max_mp: 0, attack_power: 4, defense_power: 2, weapon: "ใชใ", armor: "ใชใ", shield: "ใชใ" }
```
The default setting of the mode is here, so if you omit it, the default brave will be generated
**example**
```
cargo run
player name: ใใใฆใ
summary: PlayerSummary { name: "ใใใฆใ", level: 1, hp: 15, mp: 3, gold: 0, experience: 0 }
strength_status: StrengthStatus { level: 1, strength: 4, agility: 6, max_hp: 15, max_mp: 3, attack_power: 4, defense_power: 3, weapon: "ใชใ", armor: "ใชใ", shield: "ใชใ" }
```
**โ Save Mode**
Generates the "Fukkatsu no Jumon" from the parameters of the hero.
<img width="400" src="https://raw.githubusercontent.com/retrodig/damdara/main/assets/images/fukkatsu_no_jumon.png">
**example**
```
cargo run -- -n ใ ใ -m save
ใขใฐใใใงใถใใพใใใใใใใงใถใใใใ
```
After giving the options explained above and changing the parameters, the Fufutsu no Jumon can be generated.
```
cargo run -- -n ใ ใ -e 7000 -m save
ใใใใใใใขใชใฎใฎใฟใใใใใใฆใ ใใ
```
**โ Load Mode**
Generates a brave man from the "Fukkatsu no Jumon" of fortune.
**example**
```
cargo run -- -m load -p ใขใฐใใใงใถใใพใใใใใใใงใถใใใใ
new_player from Password
player name: ใใใ
summary: PlayerSummary { name: "ใใใ\u{3000}", level: 1, hp: 14, mp: 0, gold: 0, experience: 0 }
strength_status: StrengthStatus { level: 1, strength: 4, agility: 4, max_hp: 14, max_mp: 0, attack_power: 4, defense_power: 2, weapon: "ใชใ", armor: "ใชใ", shield: "ใชใ" }
```
**โ Display Mode**
```
cargo run -- -m display --view item
[Equipment { name: "ใชใ", price: 0, sell: 0, attack: 0, defense: 0 }, Equipment { name: "ใใใพใค", price: 8, sell: 4, attack: 0, defense: 0 }, Equipment { name: "ใใใใ", price: 12, sell: 6, attack: 0, defense: 0 }, Equipment { name: "ใญใกใฉใฎใคใฐใ", price: 24, sell: 12, attack: 0, defense: 0 }, Equipment { name: "ใใ
ใใฎใใใ", price: 20, sell: 10, attack: 0, defense: 2 }, Equipment { name: "ใใใใใฎใตใ", price: 0, sell: 0, attack: 0, defense: 0 }, Equipment { name: "ใใใใฎใใณใ", price: 0, sell: 0, attack: 2, defense: 0 }, Equipment { name: "ใญใใฎใใใ", price: 0, sell: 0, attack: 0, defense: 0 }, Equipment { name: "ใใใใใฎใใ", price: 0, sell: 0, attack: 0, defense: 0 }, Equipment { name: "ใฎใใใฎใใซใ", price: 0, sell: 0, attack: 0, defense: 0 }, Equipment { name: "ใใใฎใใฆใใจ", price: 0, sell: 0, attack: 0, defense: 0 }, Equipment { name: "ใใฎใใณใใใ", price: 0, sell: 0, attack: 0, defense: 0 }, Equipment { name: "ใใใใใฎใใ", price: 0, sell: 0, attack: 0, defense: 0 }, Equipment { name: "ใใพใใใฎใคใ", price: 0, sell: 0, attack: 0, defense: 0 }, Equipment { name: "ใซใใฎใใใ", price: 0, sell: 0, attack: 0, defense: 0 }]
```
```
cargo run -- -m display --view item 5
item: Equipment { name: "ใใใใใฎใตใ", price: 0, sell: 0, attack: 0, defense: 0 }
```
**Display Patterns**
- item
- weapon
- armor
- shield
- status
- monster
- town
- message
**โ Battle Mode**
Now, if you have given birth to a brave man, let's head into battle.
Enter commands and defeat the slime!
```
cargo run -- -m battle
ในใฉใคใ ใใใใใใ๏ผ
ใใใฆใ HP: 15
ในใฉใคใ HP: 3
--- ใใใฆใใฎใฟใผใณ ---
ใณใใณใ๏ผ
1: ใใใใ
2: ใใ
ใใ
3: ใฉใใ
4: ใซใใ
```
If you've been hit, then take on the challenge with the best equipment!
```
cargo run -- -n ใ ใ -o max -m battle
ในใฉใคใ ใใใใใใ๏ผ
ใใใใ HP: 190
ในใฉใคใ HP: 3
--- ใใใใใฎใฟใผใณ ---
ใณใใณใ๏ผ
1: ใใใใ
2: ใใ
ใใ
3: ใฉใใ
4: ใซใใ
```
You can fight any monster by specifying the id of the enemy in the `--view` option.
You can fight the last boss right away.
```
cargo run -- -n ใ ใ -o max -m battle --view 39
ใใ
ใใใใใใใใใ๏ผ
ใใใใ HP: 190
ใใ
ใใใ HP: 129
--- ใใใใใฎใฟใผใณ ---
ใณใใณใ๏ผ
1: ใใใใ
2: ใใ
ใใ
3: ใฉใใ
4: ใซใใ
```
Beware of strong flames.
```
ใใ
ใใใใฏ ใปใฎใใใฏใใ!
ใใใใใฏ 44ใใคใณใใฎ
ใใกใผใธใ ใใใ
ใใใใ HP: 146
ใใ
ใใใ HP: 129
```
### Status Option
`--option` or the shortcut `-o` can be used to specify status options
```
cargo run -- -o <input>
```
If max is specified, the parameter and story state will be the strongest
<img width="400" src="https://raw.githubusercontent.com/retrodig/damdara/main/assets/images/strongest_parameters.png">
**example**
```
cargo run -- -o max
player name: ใใใฆใ
summary: PlayerSummary { name: "ใใใฆใ", level: 30, hp: 15, mp: 3, gold: 65535, experience: 65535 }
strength_status: StrengthStatus { level: 30, strength: 140, agility: 120, max_hp: 210, max_mp: 183, attack_power: 182, defense_power: 110, weapon: "ใญใใฎใคใใ", armor: "ใญใใฎใใใ", shield: "ใฟใใใฟใฎใใฆ" }
```
### Format Option
The output format can be changed by giving the `--format`.
```
cargo run -- --format <input>
```
Format Name | Description
-------------|-------------------------------------------------------------------|
print | It will be a print statement output. This is the default setting. |
json | Output in JSON format |
### Example
## Additional Resources
## Contributing to Damdara
To contribute to **Damdara**, follow these steps:
1. Fork this repository.
2. Create a branch: `git checkout -b <branch_name>`.
3. Make your changes and commit them: `git commit -m '<commit_message>'`.
4. Push your changes to your branch: `git push origin <branch_name>`.
5. Create a pull request.
Alternatively, consult
the [GitHub documentation](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests) on how to create a
pull request.
## References
- [ๅๅใซใใๆ้ท็ใฟใคใใฎๅคๅ](https://way78.com/dq1/fc/name.html)
- [DQ1ใฎใใตใฃใใคใฎใใ
ใใใใฎไป็ตใฟใๅ
จ่งฃ่ชฌ](https://qiita.com/musemyuzu/items/eb08f7790df356434e0f?utm_source=pocket_shared)
- [ๅพฉๆดปใฎๅชๆใ่งฃๆใใฆใฟใใ](https://qiita.com/yoshi389111/items/29ade2f62483e9c095d9)
- [ใตใฃใใคใฎใใ
ใใใฃใฆไฝ๏ผๅบๆฌใฎไฝฟใๆนใใไป็ตใฟใปๅ็ใพใงใๅ็ปไธๆฌใงๅ
จใฆใใใ๏ผใFCใใใใฃใใ่งฃ่ชฌใ](https://youtu.be/a15mmjJqQKo?si=zJ2SahsbcKoeZSSP)
- [ใใฉใดใณใฏใจในใ ๆป็ฅใป่งฃๆ](https://gcgx.games/dq1/)
- [ใใฉใดใณใฏใจในใ (FC) ๅพฉๆดปใฎๅชๆ่จ็ฎๆฉ](https://taotao54321.github.io/DQ1PasswordCalc/)
- [ไธปไบบๅ
ฌใฎๅๅใจ่ฝๅๆ้ทใฎๅบ็ค FCDQ1](https://dqff.sakura.ne.jp/dq1fc/data/lvup-name.html)
- [DQ1(FC็)ๅผทใๅคๆญใใญใฐใฉใ ](https://sutton-kyouwa.com/cgi-bin/dq1.cgi)
## License
This project is licensed under the MIT License. See the [LICENSE](/LICENSE) file for details.
All monsters, images and other copyrights belong to Square Enix.
## Author
**Daisuke Takayama**
- [@webcyou](https://twitter.com/webcyou)
- [@panicdragon](https://twitter.com/panicdragon)
- <https://github.com/webcyou>
- <https://github.com/webcyou-org>
- <https://github.com/panicdragon>
- <https://www.webcyou.com/>