# 🏰 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 spells from parameters （Parameters to Password）
- [x] Parameters generated from resurrection spells (Password to Parameters)
- [x] Calculate parameters enhanced by name
- [ ] See list of monsters
- [ ] 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: "なし" }
```
### Mode
You can specify the mode by giving `--mode` or the shortcut `-m`.
```
cargo run -- --mode <input>
cargo run -- -m <input>
```
**example**
```
cargo run -- -n だい -m save
ぢばげぞでぶいまももれぎざぞでぶいよごぜ
```
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 |
**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
-
### Status Option
`--option` or the shortcut `-o` can be used to specify status options
```
cargo run -- -o <input>
```
**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.
## 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/>