Professional Documents
Culture Documents
README MD
README MD
All assets for the game, except card images. See LICENSE and COPYING in each folder
for proper credits, copyright, and rules for redistribution.
On Windows, please do not put your game install in Program Files, Downloads, or any
other location that might be read-only or require admin permissions.
On Linux, after moving the game install to your preferred location, you can run
`./install.sh` from a terminal to install desktop files for the current user.
## System requirements
Supported platforms:
- Windows 7 or later, 32-bit or 64-bit
- macOS 10.11 or later
- 64-bit GNU/Linux with X11 and glibc 2.27+ (e.g. Debian 10+, Ubuntu 18.04+,
Fedora, CentOS 8+, rolling release distros like Arch)
- You may need to install FreeType from your package manager.
1 GB free RAM recommended, though the game is not expected to exceed 300 MB of
memory unless you spam the restart button.
### General:
* ESC: Minimizes the window if not typing
* F9: Reload audio
* F11: Toggles fullscreen
* F12: Captures a screenshot
* CTRL+O: Opens the additional settings window
* R: Reloads fonts if not typing
* CTRL+R: Reloads current skin
* CTRL+1: Switch to card info tab
* CTRL+2: Switch to duel log tab
* CTRL+3: Switch to chat log tab
* CTRL+4: Switch to settings tab
* CTRL+5: Switch to repositories tab
* Drag and drop support for files and text:
* drop an `ydk` file in the main menu or the deck edit area to load that deck
* drop a card passcode or card name in the deck edit area to add that card to
the deck
* drop a `ydke://` URL in the deck edit area to load the deck specified by
that URL
* drop a `yrpX` file in the main menu or the replay selection menu to load
that replay, if valid
* drop a Lua file in the main menu or the puzzle selection menu to load that
puzzle, if valid
* drop text in a text box to insert text
### Deck editor:
* Right Mouse Button: Adds/removes a card from the deck
* Middle Mouse Button: Adds another copy of a card to the deck or side deck
* Shift+Right Mouse Button or Hold Left Mouse Button then click Right Mouse Button:
Adds a card to the side deck
* With the exception of Shift+Right Mouse Button, holding Shift will ignore ALL
deck building rules
### Duel:
* Hold A or Hold Left Mouse Button: Lets the system stop at every timing.
* Hold S or Hold Right Mouse Button: Lets the system skip every timing.
* Hold D: Lets the system stop at available timing.
* F1 to F4: Shows the cards in your GY, banished, Extra Deck, Xyz Materials
respectively.
* F5 to F8: Shows the cards in your opponent's GY, banished, Extra Deck, Xyz
Materials respectively.
### macOS:
Note that system hotkeys may intercept some of the above keyboard shortcuts.
The following app shortcuts are also available in the app and dock menus:
* Cmd+N opens a new instance with audio muted
* Cmd+Q quits the game
* Ctrl+Cmd+F toggles fullscreen
These can be combined. Example: `@blue-eyes||$eyes of blue` returns all cards that
belong to either the `Blue-Eyes` archetype or have `Eyes of Blue` in their names.
The ATK, DEF, Level/Rank, and Scale textboxes support searching for `?`. You can
also prefix the search with comparison modifiers <, <=, >=, >, and =.
## Test hand
A rudimentary hand test mode is accessible from the deck editor, with quick
restart.
The duel will never end normally in this game mode (e.g. running out of LP, decking
out)
Notice that, at the moment, the opponent has no deck for you to interact with,
which causes some effects to be unplayable (e.g. One Day of Peace)
Your status on Discord will update to be playing a game, including elapsed time.
Activities displayed in Rich Presence:
* Dueling
* In menu
* Playing a puzzle
* Watching a replay
* Editing a deck
## Customization
### Skins:
Editable by adding subfolders to **skin**. For each folder, provide a unique
`skin.xml` file, with the changes you want.
You can switch skins in the settings (CTRL+O). For instructions on the supported
fields and what they change, see README in `skin`.
### Audio:
See README in `sound`. There are many new features, including summon chants!
Music and sound volume controls are also separated.
## Advanced configuration
### system.conf
`config/system.conf` handles most of the configurations available in the game. It
is overwritten when the game is closed normally.
Only options not directly configurable in-game are listed here.
Configurations listed as "boolean" accept either 0 for 'disabled' or 1 for
'enabled'.
If a character cannot be found in the supplied font, it will not be displayed. The
shipped font supports all characters that appear on Yu-Gi-Oh! cards in Latin
alphabets and Japanese.
### configs.json
`config/configs.json` handles the servers the client is connected to, which include
repositories for updates, servers for duels and pictures.
#### posixPathExtension
Used on macOS and Linux as additional search paths for Mono, required to run
WindBot Ignite. Generally you should not need to change this.
* aht
* AlphaKretin
* andré
* Cybercatman
* edo9300
* Eerie Code
* Hatter
* Hel
* Larry126
* Logical Nonsense
* Naim
* pyrQ
### Client
* Localhost AI added with up to four bots per duel in the first four player slots.
* Uses custom WindBot Ignite.
* 27 AI decks.
* Bots incompatible with the Master Rule used in the room are not displayed.
* Decks used by Windbot do not necessarily match the current banlist: they
follow the OCG banlist available when they were implemented.
* To avoid warning regarding banned cards, the "Don't Check the Deck"
option is suggested.
* To duel the bot: LAN + AI -> Host -> OK -> Local AI -> Add AI Player
* List of decks Windbot has access to:
* ABC (from version 38.1.0 onwards)
* Altergeist
* Blue-Eyes
* Blue-Eyes Ritual
* Burn
* Chain Burn
* Cyberse
* Dark Magician
* Dragma (from version 38.1.0 onwards)
* Dragunity
* Dragun of Red-Eyes
* Frog
* Gren Maju Stun
* Horus
* Lightsworn Shaddoll Dino
* Mathmech (from version 38.1.0 onwards)
* Normal Monster Mash
* Normal Monster Mash II
* Orcust
* Qliphort
* R5NK
* Rainbow
* Rose Scrap Synchro
* Salamangreat
* Sky Striker
* Time Thief (from version 38.1.0 onwards)
* Toadally Awesome
* Trickstar
* Windwitch Gusto (from version 38.1.0 onwards)
* Witchcrafter Grass (from version 38.1.0 onwards)
* Yosenju
* ZEXAL Weapon
* Zoodiac
* Known bugs:
* The AI is not smart, misplaying a lot, which include but is not
limited to negating its own monsters, targetting the same cards with removal
effects, attacking monsters with higher ATK, etc.
* Some actions that require selection, like Advanced Ritual Art, might
cause the AI to hang on forever.
* Added an option to rename a deck in Deck Edit, without the user needing to edit
the file directly
* added a mechanism to prevent the usage of characters not allowed in file
names.
* Changed "Show anime cards" option to "Show unofficial cards", as other types of
cards are present.
* Puzzles can now display a message while in the puzzle selection screen, in the
"Puzzle Mode" menu:
* messages are added with the following syntax:
```lua
--[[message
insert the text here
]]
```
* Puzzles now have a "Restart" option.
* Fixed the dimensions of `field.png`, the picture used for MR1 and MR2 duels.
Credits to GK#3620, on Discord.
* The last banlist used is now remembered after leaving deck edit, a duel, or the
client.
* macOS
* Shift+Right Click to add to side deck in Deck Edit now works like on
Windows and Linux
* Known bug: invoking the binary from the Terminal directly
(./EDOPro.app/Contents/MacOS/EDOPro) will never start the game in fullscreen, but
no user should be starting the game this way anyway.
* Scripts now load from one subdirectory level in the script folder only.
* Updated many strings called with dialogue boxes and activation prompts used by
the client.
* Update incorrect strings called in the Damage Step
* All the strings used in the client are now controlled by the `strings.conf`
file, being editable, which allows translations for all these elements.
* Added support for an arbitrary number of cards in a deck (main, side, extra.)
* requires editing the deck file, might be tied with the server.
* the deck displayed in Deck Edit will no longer display a maximum of 60
cards in the main deck if the deck file contains more than that.
* Added `Duel.LinkSummon`, which removes the workarounds used for the "Unchained"
monsters.