Welcome to the CTGames documentation!

If you are viewing these files locally, please note that the latest version is hosted on ctgames.readthedocs.io.

Please read the overview section and the other sections in the introduction chapter if you are new to CTGames.

The tables of contents below and the sidebar on the left should let you easily access the documentation for your topic of interest. You can also use the search function in the top left corner.

The documentation is organised into chapters. Chapter “Introduction” explains what the project is, its overview and motivation, the technologies used, and the installation options. Chapter “Game development” gives general information for developers wishing to create games using the framework. Chapter “Template game explained” explains how to get started programming a new command-line game with the CTGames framework. Chapter “Command-line games” documents the programming interface for the CTGames framework with respect to command-line games. Chapter “Web app games” provides guidelines for how to turn a CTGames command-line game into a web app. Chapter “Animations for web app games” explains how to conveniently introduce basic 2D animation of SVG images into CTGames web app games. Chapter “CTGames framework” gives an overview of the framework and how games are executed within the framework. Chapter “Teacher portal development” introduces the web app and back-end functionality that teachers use. Finally, chapter “Game improvements” catalogues work to be done on each of the games.

Introduction

• 1. About
• 2. Overview
• 3. Technologies
• 4. Installation

Game development

• 1. Game development guidelines for CTGames
• 2. Before starting game development
• 3. CTGames code style
• 4. Guidelines for interacting with the CTGames git repository
• 5. Creating a new game
• 6. Game development resources

Template game explained

• 1. Introduction to the template game
• 2. Game behaviour in the template game
• 3. Command-line functionality in the template game
• 4. Game state in the template game
• 5. Game logic in the template game
• 6. String constants in the template game

Command-line games

• 1. Introduction to command-line games
• 2. Guidelines for command-line game development
• 3. The function create_game_round()
• 4. The function process_input_and_solve_task()
• 5. Advanced functionality supported in logic.py
• 6. Advanced functionality supported in cl.py
• 7. Checklist for command-line game completion

Web app games

• 1. Introduction to web app games
• 2. Guidelines for web app game development
• 3. The file webapp/__init__.py
• 4. The file webapp/names.py
• 5. Checklist for web app completion
• 6. The namedtuple TextImageSeq
• 7. The namedtuple InputDOMElements
• 8. The module svgcommmon

Animations for web app games

• 1. Introduction to web app animations
• 2. Guidelines for animations in web app games
• 3. Basic usage of GSAP in web apps
• 4. Learning about GSAP timelines
• 5. External resources for learning about GSAP
• 6. Choice of web app animation framework

CTGames framework

• 1. Under the hood of the CTGames framework
• 2. Separation of functionality between client and server

Teacher portal development

• 1. Introduction to the teacher portal

Game improvements

• 1. Introduction to game improvements
• 2. General improvements
• 3. Improvement suggestions for specific games

Student projects

• 1. Submitting a student project

Indices and tables

• Index

• Module Index

• Search Page