Welcome

Odyc.js is a tiny JavaScript library designed to create narrative games by combining pixels, sounds, text, and a bit of logic.
Everything is built through code, but without unnecessary complexity: your entire game can fit in a single file.

---

🎮 One Function to Make a Game

Creating a game with Odyc.js is as simple as calling createGame().
You provide your sprites, dialogs, sounds, and interactions — and the engine takes care of the rest.

createGame({
	player: {
		sprite: 7,
		position: [2, 5]
	},
	map: `
		########
		#......#
		#..X...#
		#......#
		########
	`,
	templates: {
		X: {
			sprite: 4,
			dialog: 'Hello, adventurer!'
		}
	}
})

---

🧭 Where to Start?

The documentation is organized into three main sections:

🧱 World Building

Define the player, the map, sprites, sounds, and dialogs.

⚙️ Interaction & Logic

Make your world interactive using events and game actions.

🎨 Configuration

Customize the appearance, filters, controls, colors, and screen.

---

📫 Questions or Ideas?

Odyc.js is an open and free project. You’re welcome to contribute to the documentation, suggest ideas, or ask questions on GitHub or via email at [email protected].

---

💫 Have fun!