Skip to content

Commit 09d543c

Browse files
wiztailworkswiztailworks
authored
Initial public release
Uploaded initial version of wiz_codex.py and full README.md. Includes map overlay, auto capture, and scenario support.
1 parent a1abd95 commit 09d543c

File tree

2 files changed

+2245
-0
lines changed

2 files changed

+2245
-0
lines changed

‎readme.md‎

Lines changed: 180 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,180 @@
1+
# Wiz Codex: Mapbook
2+
3+
🧭 A lightweight companion tool to automatically capture and organize dungeon maps
4+
for *Wizardry: The Five Ordeals (Steam)* explorers.
5+
6+
---
7+
8+
## 💡 Features at a Glance
9+
10+
- Auto-captures the in-game map only when opened
11+
- Floating minimap overlay (always on top, draggable)
12+
- Scenario-based map folders
13+
- English/Japanese toggle (🌐)
14+
- Read-only memory scan (safe, non-intrusive)
15+
16+
---
17+
18+
## 🚀 Quick Start
19+
20+
1. Launch *Wizardry: The Five Ordeals* (Steam)
21+
2. Start **Wiz Codex: Mapbook** *after* the game is running
22+
3. Perform a **rescan** inside a dungeon if the game was restarted
23+
24+
→ Full guide and FAQ below 👇
25+
26+
---
27+
28+
## Overview
29+
30+
If this map refuses to cooperate, even magic might not help.
31+
A lightweight companion tool for explorers wandering the dungeons of *Wizardry: The Five Ordeals (Steam)*.
32+
33+
This tool automatically captures, organizes, and displays dungeon maps.
34+
It supports scenario folders, a floating minimap overlay, and both English/Japanese UI.
35+
36+
## Quick Start
37+
38+
1. **Launch Wizardry: The Five Ordeals (Steam).**
39+
2. **Start Wiz Codex: Mapbook *after* the game is running.**
40+
If the game is not running, this tool cannot connect and will not function properly.
41+
3. **Perform an address rescan** the first time, or whenever the game has been restarted.
42+
Make sure you are inside a dungeon (exploration mode) when doing this.
43+
- You do *not* need to rescan after returning to the title screen or resetting in-game.
44+
- A rescan is needed only after fully restarting the game application, as memory addresses change each time.
45+
4. When the scan succeeds, your **direction**, **X/Y coordinates**, and **floor** will be displayed.
46+
5. Select your current scenario from the dropdown menu.
47+
- Use the ➕ button to create a new scenario folder.
48+
- Click the 📂 button to open the folder where maps are saved.
49+
6. Enable **Auto Map Capture** to save a screenshot automatically
50+
when you open the in-game map screen (not during normal gameplay).
51+
7. To display the minimap, enable the **Minimap** checkbox.
52+
The minimap window stays always on top and can be freely dragged.
53+
8. Click the 🌐 button to switch between English and Japanese.
54+
9. To exit, simply close the window.
55+
56+
> **Note:**
57+
> - Administrator rights may be required. If you see access errors, try running as administrator.
58+
> - Windows only. Not compatible with other operating systems.
59+
> - Game updates may affect compatibility; continued support is not guaranteed.
60+
> - This tool is read-only. It does *not* modify game data or interfere with gameplay.
61+
> - PyAutoGUI is used for automation and screenshots. Some antivirus software may flag this.
62+
> - Use at your own risk.
63+
64+
## Features
65+
66+
- Multiple scenario folders (map images are organized per scenario)
67+
- Floating minimap overlay (always on top, draggable)
68+
- Address rescan:
69+
- Fast mode using known tail-hex patterns from CSV
70+
- Full scan fallback (10–30 sec) if needed
71+
- Game input is locked during scanning to prevent changes
72+
- Auto map capture: triggered only when the in-game map is open
73+
- Manual map capture and scenario management
74+
- English/Japanese language toggle (🌐)
75+
- Theming available via code (for advanced users)
76+
77+
## FAQ
78+
79+
- **Which game version is supported?**
80+
Verified with the Steam version. Compatibility with future updates is not guaranteed.
81+
- **Can I manage multiple scenarios?**
82+
Yes. Each scenario has its own folder. Use the ➕ button to create new ones.
83+
- **Will there be updates or new features?**
84+
Maybe. No promises.
85+
- **What are the dependencies?**
86+
See `import` statements in the source code or `requirements.txt` (coming soon).
87+
- **Is there an EXE version?**
88+
Yes, see the Releases section.
89+
- **Can I change the theme or icon?**
90+
Not officially supported. Advanced users may edit the code directly.
91+
- **What if it doesn’t work?**
92+
Make sure to scan addresses while inside a dungeon.
93+
If problems persist, restart the tool and try again.
94+
- **Open Source / PRs?**
95+
MIT licensed. Suggestions and PRs are welcome, but may not be reviewed or merged.
96+
97+
## License
98+
99+
This tool is released under the [MIT License](LICENSE).
100+
Feel free to explore, modify, and share—just like a true adventurer would.
101+
102+
---
103+
104+
# 日本語版
105+
106+
## 概要
107+
108+
If this map refuses to cooperate, even magic might not help.
109+
『Wizardry外伝 五つの試練』（Steam）探索中のダンジョンマップを、
110+
自動でキャプチャ・整理・表示できる軽量ツールです。
111+
112+
シナリオ別フォルダ、ミニマップオーバーレイ、日本語／英語UI切替に対応しています。
113+
114+
## 使い方
115+
116+
1. **まず『五つの試練』（Steam版）を起動してください。**
117+
2. **ゲーム起動後に本ツール（Wiz Codex: Mapbook）を起動します。**
118+
ゲームが起動していないと、正常に動作しません。
119+
3. **初回またはゲームを再起動したときは、**
120+
ダンジョン内（探索中）で「アドレス再スキャン」を行ってください。
121+
- タイトル画面に戻っただけなら再スキャンは不要です。
122+
- 完全にゲームを再起動した場合（Steamウィンドウから再起動など）は、
123+
メモリアドレスが変わるためスキャンが必要です。
124+
4. スキャンが成功すると、「向き」「X/Y座標」「フロア」が表示されます。
125+
5. コンボボックスでプレイ中のシナリオを選んでください。
126+
- 「➕」で新規シナリオフォルダを作成できます。
127+
- 「📂」を押すと、マップ画像の保存先フォルダが開きます。
128+
6. **「マップ自動保存」にチェックを入れると、**
129+
ゲーム内マップ画面を開いたときにだけ自動で画像が保存されます。
130+
7. ミニマップを表示したい場合は「ミニマップ」チェックをONにしてください。
131+
ウィンドウは常に最前面に表示され、自由に移動できます。
132+
8. 「🌐」ボタンでUIの言語を切り替えられます（日本語／英語）。
133+
9. 終了するには、ウィンドウを閉じるだけです。
134+
135+
> **注意事項:**
136+
> - アクセスエラー時は「管理者として実行」してください。
137+
> - Windows専用です。他のOSでは動作しません。
138+
> - ゲームのアップデートにより動作しなくなる可能性があります。
139+
> - 本ツールは読み取り専用で、ゲームデータを変更したり干渉したりしません。
140+
> - スクリーンショットや一部自動化には PyAutoGUI を使用しています。
141+
> 一部のウイルス対策ソフトで警告が出ることがあります。
142+
> - ご利用は自己責任でお願いいたします。
143+
144+
## 主な機能
145+
146+
- シナリオ別フォルダによるマップ整理
147+
- ミニマップ表示（常に最前面・ドラッグ移動可能）
148+
- アドレス再スキャン機能
149+
- 既知の末尾16進コード（CSV）による高速スキャン
150+
- 見つからない場合はフルスキャン（10～30秒）
151+
- スキャン中はアドレス変動防止のため入力を一時ロック
152+
- 自動マップ保存（マップ画面を開いた時のみ保存）
153+
- 手動保存、シナリオ管理対応
154+
- 日本語／英語切替ボタン（🌐）
155+
- テーマ変更はコード編集で可能（上級者向け）
156+
157+
## よくある質問
158+
159+
- **対応バージョンは？**
160+
Steam版で動作確認済み。将来的なアップデートで動作しなくなる可能性があります。
161+
- **複数シナリオの管理はできる？**
162+
可能です。シナリオごとに個別フォルダで保存されます。
163+
- **今後のアップデート予定は？**
164+
未定です。
165+
- **依存モジュールは？**
166+
`requirements.txt` に記載予定です（またはコード内 import を参照）。
167+
- **EXE版はある？**
168+
Releases ページで配布予定です。
169+
- **見た目やアイコンの変更は？**
170+
公式には対応していません。コード編集できる方は自由にどうぞ。
171+
- **うまく動かないときは？**
172+
必ず「ダンジョン内」で再スキャンしてください。
173+
それでも動作しない場合は、ツールを再起動してみてください。
174+
- **OSS／PRについて**
175+
MITライセンスです。意見・PR歓迎ですが、必ず対応できるとは限りません。
176+
177+
## ライセンス
178+
179+
このツールは [MITライセンス](LICENSE) に基づき公開されています。
180+
自由に使って、改造して、冒険に役立ててください。

0 commit comments

Comments
 (0)