Difference between revisions of "How to Write a Roguelike in 15 Steps"

From RogueBasin
Jump to navigation Jump to search
(Added internal links.)
 
(9 intermediate revisions by 3 users not shown)
Line 5: Line 5:
Please add your comments -- maybe we could make this article really
Please add your comments -- maybe we could make this article really
helpful.  What are your own routes?
helpful.  What are your own routes?
* There is a school of thought in programming that data structures are more important than code: once you have the data structures right, the code will be self-evident. It may be useful to [[Code design basics|think before embarking]] about how you want to structure spatial information, a [[Data_structures_for_the_map|list of map tiles and their properties]], character information, monster/NPC information, and information regarding objects and marks/sound/scent/footprints or tracks on the map (if at all). Cases where these types of decisions may become significant include conflict between monsters/NPCs, invisibility, flying, falling, gradients (like climbing hills), line of sight, transmogrify (becoming another being), save/restore, any situation in which map tiles are modified (burned, tunneled, teleported, melted, duplicated, scorched, etc.), and area transitions. Overground/wilderness areas often present different requirements to traditional dungeons. [[User:Pratyeka|pratyeka]]


== Step 1 - Decide to write a game ==
== Step 1 - Decide to write a game ==
Line 13: Line 15:
playing yourself.
playing yourself.


Don't start by asking around about the definition of roguelike game -- you don't
Don't start by asking around about the definition of [[roguelike]] -- you don't
need it. If the game you write is not considered roguelike by others, but it's
need it. If the game you write is not considered roguelike by others, but it's
still fun to play for you -- you succeeded.  It's not like there's some kind of
still fun to play for you -- you succeeded.  It's not like there's some kind of
Line 22: Line 24:
everything -- it's just impossible.  When you write a design doc, you make a lot
everything -- it's just impossible.  When you write a design doc, you make a lot
of decisions. Most of the decisions can't be made without performing some test
of decisions. Most of the decisions can't be made without performing some test
first -- usually by writing small programs utilizing given feature. It's best to
first -- usually by writing small programs utilizing a given feature. It's best to
make the decisions when your project has already reached appropriate stage --
make the decisions when your project has already reached the appropriate stage --
when you don't need to write an additional program, because your project already
when you don't need to write an additional program, because your project already
has everything you need.
has everything you need.
Line 30: Line 32:
improvisation. Don't be afraid about making mistakes or implementing something
improvisation. Don't be afraid about making mistakes or implementing something
in an inflexible way -- you can improve it when you need it -- most of the time
in an inflexible way -- you can improve it when you need it -- most of the time
it will be ok.
it will be okay.


== Step 2 - Hello world! ==
== Step 2 - Hello world! ==


Prepare your programming environment. Choose your language and platform, choose
Prepare your programming environment. Choose your [[:Category:Programming languages|language]] and [[Platforms|platform]], choose
appropriate compilers/interpreters, editor, version control, automated build, and
appropriate compilers/interpreters, editor, version control, automated build, and
other utilities. Set them up so that you're comfortable with them.  
other utilities. Set them up so that you're comfortable with them.  


Decide on which libraries you're going to use -- it can change later, but it's
Decide on which [[:Category:Library|libraries]] you're going to use -- it can change later, but it's
usually a painful change. Don't think too much about portability -- it can be
usually a painful change. Don't think too much about portability -- it can be
fixed later. Think about what you need and what you're comfortable with.
fixed later. Think about what you need and what you're comfortable with.
Line 46: Line 48:
use English in your source code -- you can get more help this way from others.
use English in your source code -- you can get more help this way from others.


Don't worry about i18n yet; translation is usually a very late step in the development
Don't worry about [[i18n]] yet; translation is usually a very late step in the development
process.
process.


Line 60: Line 62:
characters, status lines and messages.
characters, status lines and messages.


Make the routine to read key-presses (no config files, no keys redefinition).
Make the routine to read key-presses (no config files, no keys redefinition, [[Preferred Key Controls]]).


Make a '@ walking around the empty screen' demo. Play with it a little, clean
Make a '@ walking around the empty screen' demo. Play with it a little, clean
Line 71: Line 73:


Decide on your map structure. Don't over-generalize -- you can add things later.
Decide on your map structure. Don't over-generalize -- you can add things later.
Make your (empty) map displayed on the screen. Scrolled if you need it.
Make your (empty) map displayed on the screen. [[Scrolling map|Scrolled if you need it.]]
Add some elements to your map to see if they are displayed correctly (just
Add some elements to your map to see if they are displayed correctly (just
hard-code them, you don't need a level generator yet).
hard-code them, you don't need a level generator yet).
Line 80: Line 82:
Now turn '@' into creature. You still don't have time implemented, so the
Now turn '@' into creature. You still don't have time implemented, so the
keyboard-reading routines will just move it around the map. Include the checks
keyboard-reading routines will just move it around the map. Include the checks
for walls in the movement code. Maybe add doors and open/close commands.
for walls in the movement code. Maybe add [[doors]] and open/close commands.


== Step 5 - Saving/Loading ==
== Step 5 - Saving/Loading ==
Line 108: Line 110:
== Step 6 - It's alive! Alive! ==
== Step 6 - It's alive! Alive! ==


Implement other creatures (monsters) and time. Add a single monster to begin with.
Implement other [[Monster|creatures (monsters)]] and time. Add a single monster to begin with.
Give him some simple AI (like, say, stay still, or maybe move randomly).
Give it some simple AI (like moving randomly).


Start with my turn-your turn, then implement the time system you want (or,
Start with my turn-your turn, then implement the [[Time Systems]] you want (or,
usually, a simplification of it and gradually make it more complicated later).
usually, a simplification of it and gradually make it more complicated later).
(Note: If you use a library, it can be easy to implement [[The Incredible Power of Dijkstra Maps]]. See also [[Dijkstra Maps Visualized]].)


Remember to test everything as you go.
Remember to test everything as you go.
Line 118: Line 122:
== Step 7 - Interaction ==
== Step 7 - Interaction ==


Add stats for your creatures. A simplification of the ones you envisioned,
Add [[stats]] for your [[creature]]s. A simplification of the ones you envisioned,
probably. It's best to add stats as they are needed, not because they 'look
probably. It's best to add stats as they are needed, not because they 'look
cool', but you might not be able to resist ;).
cool'.


Make the creatures notice each other -- bump, attack, etc. Gradually improve
Make the [[creature]]s notice each other - [[bump]], attack, etc. Gradually improve
their AIs, so that they can chase the player.
their [[AI]]s, so that they can chase the player.


Implement and test the combat system -- without equipment for now, just hardcode
Implement and test the [[combat]] system - without equipment for now, just hardcode
the values. Do lots of testing.
the values. Do lots of testing.


Line 131: Line 135:


Move the creature, map features, etc. definitions to data files. Forget about
Move the creature, map features, etc. definitions to data files. Forget about
scripting for now If something cannot be moved -- just leave it for now.
[[scripting]] for now If something cannot be moved -- just leave it.
 
(Note: This is an irrelevant step for interpreted languages. You may instead take the opportunity to organize your code in such a way as to make adding new denizens or map features an easy process.)


== Step 9 - Items ==
== Step 9 - Items ==


Add items. For start, just objects you can pick up -- no properties. Gradually
Add [[items]]. For start, just objects you can pick up -- no properties. Gradually
give them properties, kinds, stats, etc., implement inventory, picking up and
give them properties, kinds, stats, etc., implement [[inventory]], picking up and
dropping, equipping and using (no effects yet), also stacking, containers (if
dropping, equipping and using (no effects yet), also stacking, containers (if
you want them), etc.
you want them), etc.


This step usually requires lots of testing to balance.
This step usually requires lots of testing to debug.


== Step 10 - Magic ==
== Step 10 - Magic ==
   
   
Add item effects, special monster attacks, spells. Add items and monsters to
Add item effects, special monster attacks, [[spell]]s. Add items and monsters to
test them. You don't need all the possible effects right away, just the ones
test them. You don't need all the possible effects right away, just the ones
that are needed for the next step.
that are needed for the next step.
Line 161: Line 167:
== Step 12 - Levels ==
== Step 12 - Levels ==


Write your level generators. Implement moving between the levels, a wilderness and/or
Write your [[level generator]]s. Implement moving between the levels, a [[wilderness]] and/or
town if you want them, saving the levels on level change if you want them to be persistent (so that they don't take up memory).
[[town]] if you want them, saving the levels on level change if you want them to be persistent (so that they don't take up memory).


Spread your monsters and items on different depths. Add more monsters and items,
Spread your [[monster]]s and [[item]]s on different depths. Add more monsters and items,
with their effects, as needed.
with their effects, as needed.


== Step 13 - Experience ==
== Step 13 - Experience ==


Start developing your experience system and skill system. Tune the monsters' and
Start developing your [[experience]] system and skill system. Tune the monsters' and
items' stats. Make character generation screen, classes, races, and whatever else you need.
[[items]]' stats. Make a [[character generation]] screen, [[class]]es, [[race]]s, and whatever else you need.


Playtest your game frequently.
Playtest your game frequently.
Line 176: Line 182:
== Step 14 - Citizens ==
== Step 14 - Citizens ==


Add NPCs, shopkeepers, and simple quests if you need them. Keep adding
Add [[NPC]]s, [[shop]]keepers, and simple [[quest]]s if you need them. Keep adding
features and tuning the stats.
features and tuning the stats.


Line 184: Line 190:
months (years?) ago, when you started the whole thing. Revise your opinions of them and see if they fit the game.
months (years?) ago, when you started the whole thing. Revise your opinions of them and see if they fit the game.


Write your pet random plot generator, factions system, infinite wilderness
Write your pet random plot generator, [[faction]]s system, infinite [[wilderness]]
generator, neural network AI, or other unique feature, since you can now test it in a working game.
generator, neural network AI, or other unique feature, since you can now test it in a working game.



Latest revision as of 04:40, 4 January 2023

This is a rough route map for the creators of roguelikes. I'm well aware that there are many possible routes and that no two journeys are the same -- this is a description of one of possibilities and maybe will help you to plan your own.

Please add your comments -- maybe we could make this article really helpful. What are your own routes?

  • There is a school of thought in programming that data structures are more important than code: once you have the data structures right, the code will be self-evident. It may be useful to think before embarking about how you want to structure spatial information, a list of map tiles and their properties, character information, monster/NPC information, and information regarding objects and marks/sound/scent/footprints or tracks on the map (if at all). Cases where these types of decisions may become significant include conflict between monsters/NPCs, invisibility, flying, falling, gradients (like climbing hills), line of sight, transmogrify (becoming another being), save/restore, any situation in which map tiles are modified (burned, tunneled, teleported, melted, duplicated, scorched, etc.), and area transitions. Overground/wilderness areas often present different requirements to traditional dungeons. pratyeka

Step 1 - Decide to write a game

Most of you will have this step behind you already, but there are some hints about the direction of the first step. The best reason to start developing your own roguelike game is to create a game that you will enjoy playing yourself.

Don't start by asking around about the definition of roguelike -- you don't need it. If the game you write is not considered roguelike by others, but it's still fun to play for you -- you succeeded. It's not like there's some kind of a contest to write a game meeting certain specifications.

Don't plan too much. Of course, if you want certain things in your game, you must write it so that there is room for them -- but don't even try to anticipate everything -- it's just impossible. When you write a design doc, you make a lot of decisions. Most of the decisions can't be made without performing some test first -- usually by writing small programs utilizing a given feature. It's best to make the decisions when your project has already reached the appropriate stage -- when you don't need to write an additional program, because your project already has everything you need.

It's no fun to just proceed according to plan -- leave some space for improvisation. Don't be afraid about making mistakes or implementing something in an inflexible way -- you can improve it when you need it -- most of the time it will be okay.

Step 2 - Hello world!

Prepare your programming environment. Choose your language and platform, choose appropriate compilers/interpreters, editor, version control, automated build, and other utilities. Set them up so that you're comfortable with them.

Decide on which libraries you're going to use -- it can change later, but it's usually a painful change. Don't think too much about portability -- it can be fixed later. Think about what you need and what you're comfortable with.

Decide on the language you want to write comments and object names in your code, as well as the language you want to be used in your game. It's strongly recommended to use English in your source code -- you can get more help this way from others.

Don't worry about i18n yet; translation is usually a very late step in the development process.

Write a simple 'Hello world!' program and test whether it works. Test your libraries, etc. -- you don't want any surprises.

Start coding.

Step 3 - It's a boy!

Start with screen output and keyboard input. Decide preemptively on your screen layout (easy, you can change it later) and make the routines that display map characters, status lines and messages.

Make the routine to read key-presses (no config files, no keys redefinition, Preferred Key Controls).

Make a '@ walking around the empty screen' demo. Play with it a little, clean things up, play some more, imagining the game is finished and you're playing it.

Make the message handling routines -- especially for the debugging messages -- they come in handy.

Step 4 - The map

Decide on your map structure. Don't over-generalize -- you can add things later. Make your (empty) map displayed on the screen. Scrolled if you need it. Add some elements to your map to see if they are displayed correctly (just hard-code them, you don't need a level generator yet).

Make your '@' appear on the map -- not as it's element at first, just as a cursor. Test the scrolling, maybe make a 'look' command.

Now turn '@' into creature. You still don't have time implemented, so the keyboard-reading routines will just move it around the map. Include the checks for walls in the movement code. Maybe add doors and open/close commands.

Step 5 - Saving/Loading

(First: Note that you can initially do away with save and load entirely - a feature not present in many early implementations - and generate your dungeons instead of hard-coding them, which is arguably a more roguelike approach!)

Read the map from a file instead of hard-coding it. You can play with it and test different configurations if you make it human-readable from the start.

Add the 'save' command and the procedures to save your game -- the map at first, then, gradually, all of other game elements. From now on, when you implement something that needs saving, also implement saving it as soon as possible.

Here's a handy article about save files and how to implement them; it's worthwhile to read when planning ahead what form you'll save things in.

Once you work with files, you can make your preferences and keybindings config files. Again, if you make them human-readable, you'll save yourself a lot of trouble.

Now, when you're not sure how any element of the game works, you can save the game to a file and just check it.

Step 6 - It's alive! Alive!

Implement other creatures (monsters) and time. Add a single monster to begin with. Give it some simple AI (like moving randomly).

Start with my turn-your turn, then implement the Time Systems you want (or, usually, a simplification of it and gradually make it more complicated later).

(Note: If you use a library, it can be easy to implement The Incredible Power of Dijkstra Maps. See also Dijkstra Maps Visualized.)

Remember to test everything as you go.

Step 7 - Interaction

Add stats for your creatures. A simplification of the ones you envisioned, probably. It's best to add stats as they are needed, not because they 'look cool'.

Make the creatures notice each other - bump, attack, etc. Gradually improve their AIs, so that they can chase the player.

Implement and test the combat system - without equipment for now, just hardcode the values. Do lots of testing.

Step 8 - Data files

Move the creature, map features, etc. definitions to data files. Forget about scripting for now If something cannot be moved -- just leave it.

(Note: This is an irrelevant step for interpreted languages. You may instead take the opportunity to organize your code in such a way as to make adding new denizens or map features an easy process.)

Step 9 - Items

Add items. For start, just objects you can pick up -- no properties. Gradually give them properties, kinds, stats, etc., implement inventory, picking up and dropping, equipping and using (no effects yet), also stacking, containers (if you want them), etc.

This step usually requires lots of testing to debug.

Step 10 - Magic

Add item effects, special monster attacks, spells. Add items and monsters to test them. You don't need all the possible effects right away, just the ones that are needed for the next step.

Step 11 - Simple game

Try to make a simple, hard-coded game. Play it and give it to your friends. Test the mechanics you've implemented so far. See if the game is fun.

Change everything you need to change. Don't forget to test a lot. Always ask someone to test the game's 'fun factor', or test it yourself after a while; it's hard to notice some things right away.

This step should take a pretty long time, until you've got a playable, fun mini-game.

Step 12 - Levels

Write your level generators. Implement moving between the levels, a wilderness and/or town if you want them, saving the levels on level change if you want them to be persistent (so that they don't take up memory).

Spread your monsters and items on different depths. Add more monsters and items, with their effects, as needed.

Step 13 - Experience

Start developing your experience system and skill system. Tune the monsters' and items' stats. Make a character generation screen, classes, races, and whatever else you need.

Playtest your game frequently.

Step 14 - Citizens

Add NPCs, shopkeepers, and simple quests if you need them. Keep adding features and tuning the stats.

Step 15 - Free at last

Start adding and testing all the 'unique' features you thought were so cool months (years?) ago, when you started the whole thing. Revise your opinions of them and see if they fit the game.

Write your pet random plot generator, factions system, infinite wilderness generator, neural network AI, or other unique feature, since you can now test it in a working game.


Original version submitted to rec.games.roguelike.development by Radomir 'The Sheep' Dopieralski