Difference between revisions of "Complete Roguelike Tutorial, using python+libtcod"

From RogueBasin
Jump to navigation Jump to search
m (fix libtcod links)
 
(38 intermediate revisions by 8 users not shown)
Line 1: Line 1:
<center><table border="0" cellpadding="10" cellspacing="0" style="background:#F0E68C" width="60%"><tr><td><center>
<b>This tutorial is for libtcod 1.6.0 and above.</b>
If you would prefer to do the tutorial for an older version of libtcod, you can get there through one of the links below.  Be aware that the only way to get bug fixes, is by upgrading to the latest version.  There are no bug fix releases of older versions.
For libtcod version 1.5.1, [http://www.roguebasin.com/index.php?title=Complete_Roguelike_Tutorial,_using_python%2Blibtcod&oldid=42760 here] is the older version of this tutorial.<br/>
For libtcod version 1.5.0, [http://roguebasin.roguelikedevelopment.org/index.php?title=Complete_Roguelike_Tutorial,_using_python%2Blibtcod,_part_1&oldid=29855 here] is the older version of this tutorial.
</center></td></tr></table></center>
__TOC__
__TOC__


Line 6: Line 16:


Welcome to this tutorial! As you probably guessed, the goal is to have a one-stop-shop for all the info you need on how to build a good Roguelike from scratch. We hope you find it useful! But first, some quick Q&A.
Welcome to this tutorial! As you probably guessed, the goal is to have a one-stop-shop for all the info you need on how to build a good Roguelike from scratch. We hope you find it useful! But first, some quick Q&A.


=== Why Python? ===
=== Why Python? ===


Most people familiar with this language will tell you it's fun!  Python aims to be simple but powerful, and very accessible to beginners.  This tutorial would probably be much harder without it. We recommend that you install Python 2.7 and go through at least the first parts of the [http://docs.python.org/tutorial/ Python Tutorial]. (Note for Windows 7 64-bits users: install the 32-bits version, since the 64-bits version of Python seems to cause problems with libtcod.) This tutorial will be much easier if you've experimented with the language first. Remember that the [http://docs.python.org/library/index.html Python Library Reference] is your friend -- the standard library has everything you might need and when programming you should be ready to search it for help on any unknown function you might encounter.
Most people familiar with this language will tell you it's fun!  Python aims to be simple but powerful, and very accessible to beginners.  This tutorial would probably be much harder without it. We insist that you install/use Python 2.7 and go through at least the first parts of the [http://docs.python.org/tutorial/ Python Tutorial]. This tutorial will be much easier if you've experimented with the language first. Remember that the [http://docs.python.org/library/index.html Python Library Reference] is your friend -- the standard library has everything you might need and when programming you should be ready to search it for help on any unknown function you might encounter.


Python 2 is the most used version, and it's very stable. Currently libtcod is not compatible with Python 3. There's also a section on [[Complete Roguelike Tutorial, using python+libtcod#Other_languages|other languages]].
<center><table border="0" cellpadding="10" cellspacing="0" style="background:#F0E68C" width="60%"><tr><td><center>
This tutorial is for <b>Python 2 only</b>, and it is strongly recommended you use the latest Python 2.7 release.


If you choose to use earlier versions of Python 2, you may encounter problems you need to overcome.<br/>
If you choose to use Python 3, be aware this tutorial is not compatible with it and you are on your own. (See "other languages" below.)
</center></td></tr></table></center>


=== Why libtcod? ===
=== Why libtcod? ===


If you haven't seen it in action yet, check out the [http://roguecentral.org/doryen/libtcod/features/ features] and [http://roguecentral.org/doryen/projects-2/ some projects] where it was used successfully. It's extremely easy to use and has tons of useful functions specific to RLs.
If you haven't seen it in action yet, check out the [https://bitbucket.org/libtcod/libtcod/wiki/Features features] and [http://roguecentral.org/doryen/projects-2/ some projects] where it was used successfully. It's extremely easy to use and has tons of useful functions specific to RLs.


The tutorial uses libtcod 1.5.1. If you would prefer to use version 1.5.0, follow the link at the top of each lesson and code page for the older version.
If you're using Windows, download either the Win32 or x64 build [https://bitbucket.org/libtcod/libtcod/downloads from bitbucket]. Various samples are prebuilt and included, and can be used to both experiment with the various features and see what is possible.


For other platforms, you're going to have to compile them yourself.  Maybe someone who owns a MacOS machine might compile builds for the libtcod project?
=== Other languages ===
There are no known versions of this tutorial for other programming languages than Python, for libtcod 1.6.0.  However, you can hop back to [http://www.roguebasin.com/index.php?title=Complete_Roguelike_Tutorial,_using_python%2Blibtcod&oldid=43255 the tutorial for 1.5.1] and find some option there to work from.
[http://rogueliketutorials.com/ Here] you'll find completed ports, one for Python 3 and libtcod (revising this tutorial "with good coding practices kept in mind from the beginning") and another for Python 3 and TDL, created by [https://www.reddit.com/user/TStand90 /u/TStand90] for r/roguelikedev [https://www.reddit.com/r/roguelikedev/wiki/python_tutorial_series Tutorial Tuesday 2017].
A separate work-in-progress port of this tutorial for Python 3 and tdl (a pythonic cffi port of libtcod) can be found [http://www.roguebasin.com/index.php?title=Roguelike_Tutorial,_using_python3%2Btdl here].


==Start the tutorial==
==Start the tutorial==
Line 93: Line 115:
* '''[[Complete Roguelike Tutorial, using Python+libtcod, extras#Real-time combat|Real-time combat]]'''
* '''[[Complete Roguelike Tutorial, using Python+libtcod, extras#Real-time combat|Real-time combat]]'''
*: A speed system to change the tutorial's turn-based combat to real-time!
*: A speed system to change the tutorial's turn-based combat to real-time!
* '''[[Complete Roguelike Tutorial, using Python+libtcod, extras#Mouse-driven Menus|Mouse-driven menus]]'''
*: Add basic mouse support to your menus!


* '''[[Complete Roguelike Tutorial, using python+libtcod, extras scrolling code|Scrolling maps]]'''  
* '''[[Complete Roguelike Tutorial, using python+libtcod, extras scrolling code|Scrolling maps]]'''  
Line 100: Line 125:
*: Package and deliver your game the nice way!
*: Package and deliver your game the nice way!


* '''[[Complete Roguelike Tutorial, using Python+libtcod, extras#A* Pathfinding|A* Pathfinding]]'''
*: A good pathfinding system


== Other languages ==
* '''[[Complete Roguelike Tutorial, using Python+libtcod, extras#Using Graphical Tiles|Using Graphical Tiles]]'''
 
*: An alternative to solid colors or ASCII graphics
A partial, work-in-progress C++ port of this tutorial can be found [http://codeumbra.eu/complete-roguelike-tutorial-using-c-and-libtcod-part-1-setting-up here].


* '''[[Complete Roguelike Tutorial, using Python+libtcod, extras#BSP Dungeon Generator|BSP Dungeon Generator]]'''
*: Binary Space Partitioning Dungeon Generator


==Credits==
==Credits==
Line 110: Line 138:
Code and tutorial written by Jo&atilde;o F. Henriques (a.k.a. Jotaf). Thanks go out to George Oliver for helping with the layout, sections rearrangement, and syntax highlighting; Teddy Leach for his text reviews; and all the folks in the libtcod forums for their valuable feedback!
Code and tutorial written by Jo&atilde;o F. Henriques (a.k.a. Jotaf). Thanks go out to George Oliver for helping with the layout, sections rearrangement, and syntax highlighting; Teddy Leach for his text reviews; and all the folks in the libtcod forums for their valuable feedback!


Feel free to stop by the [http://roguecentral.org/doryen/forum/index.php?board=20.0 libtcod/Python forum] or the [http://roguecentral.org/doryen/forum/index.php?topic=328.0 forum on this tutorial] if you're stuck, to show your own project, or just to say hi! It's always cool to get some feedback on the tutorial, and hear about other roguelikes in development.
The most active place to discuss this tutorial, or libtcod in general, is the [https://www.reddit.com/r/roguelikedev/ roguelikedev subreddit].  Post if you're stuck, to show your own project, or just to say hi.  It's always cool to get some feedback on the tutorial, and hear about other roguelikes in development.  Also, past discussions can either be found in the old [http://roguecentral.org/doryen/forum/index.php?board=20.0 libtcod/Python forum] or the old [http://roguecentral.org/doryen/forum/index.php?topic=328.0 forum on this tutorial].


[[Category: Developing]]
[[Category: Developing]]

Latest revision as of 01:25, 14 September 2017

This tutorial is for libtcod 1.6.0 and above.

If you would prefer to do the tutorial for an older version of libtcod, you can get there through one of the links below. Be aware that the only way to get bug fixes, is by upgrading to the latest version. There are no bug fix releases of older versions.

For libtcod version 1.5.1, here is the older version of this tutorial.
For libtcod version 1.5.0, here is the older version of this tutorial.


Short introduction

Welcome!

Welcome to this tutorial! As you probably guessed, the goal is to have a one-stop-shop for all the info you need on how to build a good Roguelike from scratch. We hope you find it useful! But first, some quick Q&A.

Why Python?

Most people familiar with this language will tell you it's fun! Python aims to be simple but powerful, and very accessible to beginners. This tutorial would probably be much harder without it. We insist that you install/use Python 2.7 and go through at least the first parts of the Python Tutorial. This tutorial will be much easier if you've experimented with the language first. Remember that the Python Library Reference is your friend -- the standard library has everything you might need and when programming you should be ready to search it for help on any unknown function you might encounter.

This tutorial is for Python 2 only, and it is strongly recommended you use the latest Python 2.7 release.

If you choose to use earlier versions of Python 2, you may encounter problems you need to overcome.
If you choose to use Python 3, be aware this tutorial is not compatible with it and you are on your own. (See "other languages" below.)

Why libtcod?

If you haven't seen it in action yet, check out the features and some projects where it was used successfully. It's extremely easy to use and has tons of useful functions specific to RLs.

If you're using Windows, download either the Win32 or x64 build from bitbucket. Various samples are prebuilt and included, and can be used to both experiment with the various features and see what is possible.

For other platforms, you're going to have to compile them yourself. Maybe someone who owns a MacOS machine might compile builds for the libtcod project?

Other languages

There are no known versions of this tutorial for other programming languages than Python, for libtcod 1.6.0. However, you can hop back to the tutorial for 1.5.1 and find some option there to work from.

Here you'll find completed ports, one for Python 3 and libtcod (revising this tutorial "with good coding practices kept in mind from the beginning") and another for Python 3 and TDL, created by /u/TStand90 for r/roguelikedev Tutorial Tuesday 2017.

A separate work-in-progress port of this tutorial for Python 3 and tdl (a pythonic cffi port of libtcod) can be found here.

Start the tutorial

Follow the first link to get started!


  • Part 1: Graphics
    Start your game right away by setting up the screen, printing the stereotypical @ character and moving it around with the arrow keys.


  • Part 2: The object and the map
    This introduces two new concepts: the generic object system that will be the basis for the whole game, and a general map object that you'll use to hold your dungeon.




  • Part 5: Preparing for combat
    Place some orcs and trolls around the dungeon (they won't stay there for long!). Also, deal with blocking objects and game states, which are important before coding the next part.



  • Part 7: The GUI
    A juicy Graphical User Interface with status bars and a colored message log for maximum eye-candy. Also, the infamous "look" command, with a twist: you can use the mouse.


  • Part 8: Items and Inventory
    The player gets to collect ("borrow") items from the dungeon and use them, with a neat inventory screen. More items added in the next part.


  • Part 9: Spells and ranged combat
    The player's strategic choices increase exponentially as we add a few magic scrolls to the mix. Covers damage and mind spells, as well as ranged combat.





  • Part 13: Adventure gear
    Swords, shields and other equipment can now help the player by granting hefty bonuses. The bonus system can also be used for all kinds of magics and buffs!


Extras

Some stuff that is entirely optional and didn't make it in; check this out if you finished the tutorial and are looking for some modifications and improvements to your game -- some are easy, others are more advanced.


  • Real-time combat
    A speed system to change the tutorial's turn-based combat to real-time!
  • Scrolling maps
    Placeholder page for the scrolling map code. Tutorial text will be written soon.

Credits

Code and tutorial written by João F. Henriques (a.k.a. Jotaf). Thanks go out to George Oliver for helping with the layout, sections rearrangement, and syntax highlighting; Teddy Leach for his text reviews; and all the folks in the libtcod forums for their valuable feedback!

The most active place to discuss this tutorial, or libtcod in general, is the roguelikedev subreddit. Post if you're stuck, to show your own project, or just to say hi. It's always cool to get some feedback on the tutorial, and hear about other roguelikes in development. Also, past discussions can either be found in the old libtcod/Python forum or the old forum on this tutorial.