Welcome to the python-tcod documentation!

Contents:

• Installation
  • Windows
  • MacOS
  • Linux (Debian-based)
  • PyCharm
  • Upgrading python-tcod
  • Upgrading from libtcodpy to python-tcod
  • Distributing
  • Python 2.7
• Glossary
• Changelog
• Frequently Asked Questions
  • How do you set a frames-per-second while using contexts?
  • I get No module named 'tcod' when I try to import tcod in PyCharm.
  • How do I add custom tiles?

python-tcod API

• Getting Started
  • Fixed-size console
  • Dynamically-sized console
• Character Table Reference
  • Code Page 437
  • Deprecated TCOD Layout
• tcod.bsp - Binary Space Partitioning
  • BSP
• tcod.console - Tile Drawing/Printing
  • Console
  • get_height_rect()
  • load_xp()
  • recommended_size()
  • save_xp()
  • rgb_graphic
  • rgba_graphic
• tcod.context - Window Management
  • Context
  • new()
  • new_terminal()
  • new_window()
  • RENDERER_OPENGL
  • RENDERER_OPENGL2
  • RENDERER_SDL
  • RENDERER_SDL2
  • RENDERER_XTERM
  • SDL_WINDOW_ALLOW_HIGHDPI
  • SDL_WINDOW_BORDERLESS
  • SDL_WINDOW_FULLSCREEN
  • SDL_WINDOW_FULLSCREEN_DESKTOP
  • SDL_WINDOW_HIDDEN
  • SDL_WINDOW_INPUT_GRABBED
  • SDL_WINDOW_MAXIMIZED
  • SDL_WINDOW_MINIMIZED
  • SDL_WINDOW_RESIZABLE
• tcod.event - SDL2 Event Handling
  • Point
  • Event
  • Quit
  • KeyboardEvent
  • KeyDown
  • KeyUp
  • MouseMotion
  • MouseButtonEvent
  • MouseButtonDown
  • MouseButtonUp
  • MouseWheel
  • TextInput
  • WindowEvent
  • WindowMoved
  • WindowResized
  • JoystickEvent
  • JoystickAxis
  • JoystickBall
  • JoystickHat
  • JoystickButton
  • JoystickDevice
  • ControllerEvent
  • ControllerAxis
  • ControllerButton
  • ControllerDevice
  • Undefined
  • get_mouse_state()
  • add_watch()
  • remove_watch()
  • EventDispatch
  • get_keyboard_state()
  • get_modifier_state()
  • Getting events
  • Keyboard Enums
• tcod.image - Image Handling
  • Image
  • load()
• tcod.los - Line of Sight
  • bresenham()
• tcod.map - Field of View
  • Map
  • compute_fov()
• tcod.noise - Noise Map Generators
  • Algorithm
  • Implementation
  • Noise
  • grid()
• tcod.path - Pathfinding
  • AStar
  • CustomGraph
  • Dijkstra
  • EdgeCostCallback
  • NodeCostArray
  • Pathfinder
  • SimpleGraph
  • dijkstra2d()
  • hillclimb2d()
  • maxarray()
• tcod.random - Random Number Generators
  • Random
• tcod.render - Console Rendering Extension
  • SDLConsoleRender
  • SDLTilesetAtlas
• tcod.tileset - Font Loading Functions
  • Tileset
  • get_default()
  • load_bdf()
  • load_tilesheet()
  • load_truetype_font()
  • procedural_block_elements()
  • set_default()
  • set_truetype_font()
  • CHARMAP_CP437
  • CHARMAP_TCOD
• libtcodpy - Old API Functions
  • bsp
  • color
  • console
  • Event
  • sys
  • pathfinding
  • heightmap
  • image
  • line
  • map
  • mouse
  • namegen
  • noise
  • parser
  • random
  • struct
  • other
• tcod.sdl.audio - SDL Audio
  • AllowedChanges
  • AudioDevice
  • BasicMixer
  • Channel
  • convert_audio()
  • get_capture_devices()
  • get_devices()
  • open()
• tcod.sdl.joystick - SDL Joystick Support
  • ControllerAxis
  • ControllerButton
  • GameController
  • Joystick
  • controller_event_state()
  • get_controllers()
  • get_joysticks()
  • init()
  • joystick_event_state()
  • Power
• tcod.sdl.render - SDL Rendering
  • BlendFactor
  • BlendMode
  • BlendOperation
  • Renderer
  • RendererFlip
  • Texture
  • TextureAccess
  • compose_blend_mode()
  • new_renderer()
• tcod.sdl.mouse - SDL Mouse Functions
  • Cursor
  • SystemCursor
  • capture()
  • get_cursor()
  • get_default_cursor()
  • get_focus()
  • get_global_state()
  • get_relative_mode()
  • get_relative_state()
  • get_state()
  • new_color_cursor()
  • new_cursor()
  • new_system_cursor()
  • set_cursor()
  • set_relative_mode()
  • warp_global()
  • warp_in_window()
• tcod.sdl.video - SDL Window and Display API
  • FlashOperation
  • Window
  • WindowFlags
  • get_grabbed_window()
  • new_window()
  • screen_saver_allowed()

Indices and tables

• Index

• Module Index

• Search Page