Difference between revisions of "Roguelike Tutorial, using python3+tdl"

From RogueBasin
Jump to navigation Jump to search
m (Changed Python and tdl version information)
 
(14 intermediate revisions by the same user not shown)
Line 1: Line 1:
<center><table border="0" cellpadding="10" cellspacing="0" style="background:#F0E68C" width="60%"><tr><td><center>
<center><table border="0" cellpadding="10" cellspacing="0" style="background:#F0E68C" width="60%"><tr><td><center>
<b>The tutorial uses tld version 1.5.3 and Python 3.5</b>
<b>The tutorial uses tdl version 3.1.0 and Python 3.5<br>
It is a work in progress, and currently only features Parts 1 to 10</b>
</center></td></tr></table></center>
</center></td></tr></table></center>


Line 6: Line 7:
__TOC__
__TOC__


This article is the first part of a series closely based on by Jotaf's excellent [[Complete Roguelike Tutorial, using python+libtcod|"Complete roguelike tutorial using python + libtcod"]]. ("Closely based on" meaning copy-pasted). This version is for people who would like to follow the same steps, but use python 3 along with the [https://github.com/HexDecimal/python-tdl tdl module], rather than libtcod.
This article is the first part of a series closely based on by Jotaf's excellent [[Complete Roguelike Tutorial, using python+libtcod|Complete roguelike tutorial using python + libtcod]] ("closely based on" meaning "copy-pasted"). This version is for people who would like to follow the same steps, but use Python 3 along with the [https://github.com/HexDecimal/python-tdl tdl module], rather than libtcod.


Lots of the tdl code come from [https://github.com/HexDecimal/Complete-Roguelike-Tutorial--using-python-3-libtcod-tdl- a script] on the tdl maintainers' github page which shows the completed code for the tutorial up to part 6.  
Lots of the code comes from [https://github.com/HexDecimal/Complete-Roguelike-Tutorial--using-python-3-libtcod-tdl- a script] on the tdl maintainers' github page which showed the completed code for the tutorial up to Part 6.  


It is hoped that the tutorial will be useful for beginners and people who want to learn how to use  to create a simple [[What_a_roguelike_is#|roguelike]] video game. It covers both Linux and Windows operating systems.
It is hoped that the tutorial will be useful for beginners and people who want to learn to create a simple [[What_a_roguelike_is#|roguelike]] video game. It covers both Linux and Windows operating systems.


== '''Introduction''' ==
== '''Introduction''' ==
Line 16: Line 17:
=== 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 3.5 is fixed) 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.
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 3.5 and go through at least the first parts of the [https://docs.python.org/3/tutorial/ Python Tutorial]. This tutorial will be much easier if you've experimented with the language first. Remember that the [https://docs.python.org/3/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.


<center><table border="0" cellpadding="10" cellspacing="0" style="background:#F0E68C" width="60%"><tr><td><center>
<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.
This tutorial is for <b>Python 3 only</b>, and it is recommended you use the latest version of Python 3.5 or 3.6.


If you choose to use earlier versions of Python 2, you may encounter problems you need to overcome.<br/>
If you choose to use earlier versions of Python 3, 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.
If you choose to use Python 2, see the link below for the libtcod tutorial.
</center></td></tr></table></center>
</center></td></tr></table></center>


=== What is tdl? ===


If you feel strongly about using Python 3, then please feel free to make a Python 3 version of the [https://bitbucket.org/libtcod/libtcod/src/tip/python/?at=default libtcodpy module], and consider contributing it and maintaining it for the [https://bitbucket.org/libtcod/libtcod libtcod project].  Also feel free to make a separate set of pages here, and translate an alternate version of the tutorial with it's code written in the Python 3 dialect.  At this stage, no one has felt strongly enough to want to do this, and the people who work on libtcod have other interests and demands on their time.
TDL is a port of the C library libtcod which attempts to make it more “Pythonic.” Unlike libtcod, which closely follows the C code, it uses an object-oriented approach that is more familiar to Python users. It may also have better compatibility with Python 3, and it can easily be installed using Pip.


=== Why libtcod? ===
For more information, see the [https://pythonhosted.org/tdl/ official documentation] and the [https://github.com/HexDecimal/python-tdl github project page].


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.
=== Other languages ===
 
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 ===
* Python 2 with libtcod:
[[Complete Roguelike Tutorial, using python+libtcod]]


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.
* C++ with libtcod:
[[Complete roguelike tutorial using C++ and libtcod - part_1: setting up|Complete roguelike tutorial using C++ and libtcod]]


==Start the tutorial==
==Start the tutorial==


Follow the first link to get started!
Follow the first link to get started!
Note: I highly recommend that you keep the tdl [https://pythonhosted.org/tdl/ manual] open at all times for reference while working on this tutorial.




* '''[[Complete Roguelike Tutorial, using python+libtcod, part 1|Part 1: Graphics]]'''
* '''[[Roguelike Tutorial, using python3+tdl, part 1|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.
*: Start your game right away by setting up the screen, printing the stereotypical @ character and moving it around with the arrow keys.




* '''[[Complete Roguelike Tutorial, using python+libtcod, part 2|Part 2: The object and the map]]'''
* '''[[Roguelike Tutorial, using python3+tdl, part 2|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.
*: 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.




* '''[[Complete Roguelike Tutorial, using python+libtcod, part 3|Part 3: The dungeon]]'''
* '''[[Roguelike Tutorial, using python3+tdl, part 3|Part 3: The dungeon]]'''
*: Learn how to code up a neat little dungeon generator.
*: Learn how to code up a neat little dungeon generator.




* '''[[Complete Roguelike Tutorial, using python+libtcod, part 4|Part 4: Field-of-view and exploration]]'''
* '''[[Roguelike Tutorial, using python3+tdl, part 4|Part 4: Field-of-view and exploration]]'''
*: Display the player's field-of-view (FOV) and explore the dungeon gradually (also known as fog-of-war).
*: Display the player's field-of-view (FOV) and explore the dungeon gradually (also known as fog-of-war).




* '''[[Complete Roguelike Tutorial, using python+libtcod, part 5|Part 5: Preparing for combat]]'''
* '''[[Roguelike Tutorial, using python3+tdl, part 5|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.
*: 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.




* '''[[Complete Roguelike Tutorial, using python+libtcod, part 6|Part 6: Going Berserk!]]'''
* '''[[Roguelike Tutorial, using python3+tdl, part 6|Part 6: Going Berserk!]]'''
*: Stalking monsters, fights, splatter -- need we say more?
*: Stalking monsters, fights, splatter -- need we say more?




* '''[[Complete Roguelike Tutorial, using python+libtcod, part 7|Part 7: The GUI]]'''
* '''[[Roguelike Tutorial, using python3+tdl, part 7|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.
*: 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.




* '''[[Complete Roguelike Tutorial, using python+libtcod, part 8|Part 8: Items and Inventory]]'''
* '''[[Roguelike Tutorial, using python3+tdl, part 8|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.
*: 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.




* '''[[Complete Roguelike Tutorial, using python+libtcod, part 9|Part 9: Spells and ranged combat]]'''
* '''[[Roguelike Tutorial, using python3+tdl, part 9|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.
*: 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.




* '''[[Complete Roguelike Tutorial, using python+libtcod, part 10|Part 10: Main menu and saving]]'''  
* '''[[Roguelike Tutorial, using python3+tdl, part 10|Part 10: Main menu and saving]]'''  
*: A main menu complete with a background image and the ability to save and load the game.
*: A main menu complete with a background image and the ability to save and load the game.




* '''[[Complete Roguelike Tutorial, using python+libtcod, part 11|Part 11: Dungeon levels and character progression]]'''
* '''[[Roguelike Tutorial, using python3+tdl, part 11|Part 11: Dungeon levels and character progression]]'''
*: Let the player venture deeper into the dungeon and grow stronger, including experience gain, levels and raising stats!
*: Let the player venture deeper into the dungeon and grow stronger, including experience gain, levels and raising stats!




* '''[[Complete Roguelike Tutorial, using python+libtcod, part 12|Part 12: Monster and item progression]]'''
* '''[[Roguelike Tutorial, using python3+tdl, part 12|Part 12: Monster and item progression]]'''
*: Deeper dungeon levels become increasingly more difficult! Here we create tools for dealing with chances and making them vary with level.
*: Deeper dungeon levels become increasingly more difficult! Here we create tools for dealing with chances and making them vary with level.




* '''[[Complete Roguelike Tutorial, using python+libtcod, part 13|Part 13: Adventure gear]]'''
* '''[[Roguelike Tutorial, using python3+tdl, part 13|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!
*: 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==
==Extras==
Line 103: Line 103:




* '''[[Complete Roguelike Tutorial, using Python+libtcod, extras#A neat Python shortcut for Notepad++|A neat Python shortcut for Notepad++]]'''
* '''[[Roguelike Tutorial, using python3+tdl, extras#A neat Python shortcut for Notepad++|A neat Python shortcut for Notepad++]]'''
*: For Notepad++ users, how to set up a shortcut to help you debugging.
*: For Notepad++ users, how to set up a shortcut to help you debugging.


* '''[[Complete Roguelike Tutorial, using Python+libtcod, extras#Old-school wall and floor tiles|Old-school wall and floor tiles]]'''
* '''[[Roguelike Tutorial, using python3+tdl, extras#Old-school wall and floor tiles|Old-school wall and floor tiles]]'''
*: Using characters in tiles, without getting weird graphical glitches. This is actually very simple.
*: Using characters in tiles, without getting weird graphical glitches. This is actually very simple.


* '''[[Complete Roguelike Tutorial, using Python+libtcod, extras#Real-time combat|Real-time combat]]'''
* '''[[Roguelike Tutorial, using python3+tdl, 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]]'''
* '''[[Roguelike Tutorial, using python3+tdl, extras#Mouse-driven Menus|Mouse-driven menus]]'''
*: Add basic mouse support to your menus!
*: Add basic mouse support to your menus!


* '''[[Complete Roguelike Tutorial, using python+libtcod, extras scrolling code|Scrolling maps]]'''  
* '''[[Roguelike Tutorial, using python3+tdl, extras scrolling code|Scrolling maps]]'''  
*: Placeholder page for the scrolling map code. Tutorial text will be written soon.
*: Placeholder page for the scrolling map code. Tutorial text will be written soon.


* '''[[Complete Roguelike Tutorial, using Python+libtcod, extras#Creating a Binary|Creating a Binary]]'''
* '''[[Roguelike Tutorial, using python3+tdl, extras#Creating a Binary|Creating a Binary]]'''
*: 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]]'''
* '''[[Roguelike Tutorial, using python3+tdl, extras#A* Pathfinding|A* Pathfinding]]'''
*: A good pathfinding system
*: A good pathfinding system


* '''[[Complete Roguelike Tutorial, using Python+libtcod, extras#Using Graphical Tiles|Using Graphical Tiles]]'''
* '''[[Roguelike Tutorial, using python3+tdl, extras#Using Graphical Tiles|Using Graphical Tiles]]'''
*: An alternative to solid colors or ASCII graphics
*: An alternative to solid colors or ASCII graphics


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


==Credits==
==Credits==


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!
This tutorial is a python 3/tdl "translation," by [[User:Weilian|Weilian]], of Jotaf's excellent [[Complete Roguelike Tutorial, using python+libtcod|Complete roguelike tutorial using python + libtcod]]. As this version of the tutorial is incomplete, please see the original for more information. As mentioned above, lots of the code comes from [https://github.com/HexDecimal/Complete-Roguelike-Tutorial--using-python-3-libtcod-tdl- a script] on the tdl maintainers' github page.
 
The most active place to discuss this tutorial 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.


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].
The best way to reach me as on reddit as [https://www.reddit.com/user/weilian82/ u/weilian82].


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

Latest revision as of 08:13, 30 May 2017

The tutorial uses tdl version 3.1.0 and Python 3.5
It is a work in progress, and currently only features Parts 1 to 10


This article is the first part of a series closely based on by Jotaf's excellent Complete roguelike tutorial using python + libtcod ("closely based on" meaning "copy-pasted"). This version is for people who would like to follow the same steps, but use Python 3 along with the tdl module, rather than libtcod.

Lots of the code comes from a script on the tdl maintainers' github page which showed the completed code for the tutorial up to Part 6.

It is hoped that the tutorial will be useful for beginners and people who want to learn to create a simple roguelike video game. It covers both Linux and Windows operating systems.

Introduction

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 3.5 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 3 only, and it is recommended you use the latest version of Python 3.5 or 3.6.

If you choose to use earlier versions of Python 3, you may encounter problems you need to overcome.
If you choose to use Python 2, see the link below for the libtcod tutorial.

What is tdl?

TDL is a port of the C library libtcod which attempts to make it more “Pythonic.” Unlike libtcod, which closely follows the C code, it uses an object-oriented approach that is more familiar to Python users. It may also have better compatibility with Python 3, and it can easily be installed using Pip.

For more information, see the official documentation and the github project page.

Other languages

  • Python 2 with libtcod:

Complete Roguelike Tutorial, using python+libtcod

  • C++ with libtcod:

Complete roguelike tutorial using C++ and libtcod

Start the tutorial

Follow the first link to get started!

Note: I highly recommend that you keep the tdl manual open at all times for reference while working on this tutorial.


  • 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

This tutorial is a python 3/tdl "translation," by Weilian, of Jotaf's excellent Complete roguelike tutorial using python + libtcod. As this version of the tutorial is incomplete, please see the original for more information. As mentioned above, lots of the code comes from a script on the tdl maintainers' github page.

The most active place to discuss this tutorial 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.

The best way to reach me as on reddit as u/weilian82.