ruins

Ruins is a game described as a "roguelike" in Japanese, developed as an open-source project using the Go programming language. It is published on Steam and can also be played directly in web browsers via its GitHub Pages deployment (Play). This repository contains the game's source code, design documents, test reports, and Godoc. The game offers various features typical of the genre, including dungeon exploration, an overworld map, detailed character creation (jobs, naming, abilities, basic info, effects, equipment, health, skills), crafting menus, equipment comparison, shooting modes, shops, storage management, game over screens, and settings menus. The README displays numerous screenshots of these features, which are automatically generated images from golden tests. Controls for dungeon exploration include arrow keys for movement (Shift+Arrow for diagonal movement), Period to wait, Enter for interaction, Space for the interaction menu, G to pick up items, F to shoot, and numbers 1-5 to switch weapon slots. Verb commands are supported, such as Shift+X to examine, D to drop, E to eat/drink, R to read, and T to use. Camera operations allow rotation with Z/C and zooming with PageUp/PageDown. Menu navigation utilizes arrow keys, Tab, Enter, and Escape. On the development side, Ruins employs an Entity-Component-System (ECS) architecture, referencing open-source projects like sokoban-go and goecsengine. Design documents are located in the `docs/design` directory and can be listed using the command `go run . designdoc list`. The project maintains a comprehensive test suite that includes golden tests, along with public coverage reports. The game draws system-level inspiration from KONAMI's Power Pro Kun Pocket series and Cataclysm: Dark Days Ahead. Some fonts and image assets are sourced from open-source or free material libraries.