Skip to content

Latest commit

 

History

History
211 lines (184 loc) · 5.77 KB

TUTORIALS.md

File metadata and controls

211 lines (184 loc) · 5.77 KB

[ ABOUT | SETUP and RUN | CREATE A GAME | TUTORIALS | CONTRIBUTING ]

LAN-Caster - Tutorials

The following links and videos provide an overview of how to use LAN-Caster to build your own game. More will be added as content is created.

Python Basics

To write a game with LAN-Caster, you should have a basic familiarity with python 3. The links below will help:

LAN-Caster Game Engine Overview

  • What is LAN-Caster?
  • Where to get it: https://github.com/dbakewel/lan-caster
  • File Organization
  • Running the Demo
  • Architecture:
    • Input data (Tiled): Maps and Tilesets
    • Processes
    • Server: game logic, steps, and mechanics
    • Clients (aka players): input and display
    • Networking
  • How to make your own game?

How to write a game with LAN-Caster

  • Design

    • Game Concept and Story
    • Game Mechanics
    • Engine Enhancements and Limitations
    • Tilesets, Maps, and Code
    • Working in a Team

  • Implementation

    • File Structure and Revision Control
    • Maps and Tilesets
    • Launcher
    • Adding Code
    • Testing (-verbose, -profile, -test)
    • Incremental Improvement

Create Hello World Game in LAN-Caster

  • Concept and Design
  • Create Launcher and Directories
  • Download Graphics and Add Credits
  • Tileset
  • Map
  • "sprites" Layer
  • Player Object on sprites Layer
  • First Test
  • "ground" Layer and Tiles
  • "outOfBounds" Layer and Objects
  • "trigger" Layer
  • "helloworld" Object on trigger Layer
  • servermap.py
  • trigger code
  • final test

Tilesets in LAN-Caster

  • Tiled Tilesets
  • Images (png) files
    • Where to find and how to give credit.
    • How to make your own
  • Create Tileset file
  • Animated tiles
  • Character tiles
  • Anchor point
  • Using Tiles on a Map:
    • Tile layers
    • Tile objects

Maps in LAN-Caster

  • Tiled Maps
  • Map Requirements
  • Tilesets
  • Adding External Tilesets Layers Types:
    • Tile Layers
    • Object Layers
    • Well Defined (known or special) Layers
      • sprites
      • triggers
      • inbounds
      • outofBounds
      • reference
  • Layer Order (using black layer to help)
  • Object Anchor Points vs. (x, y)
  • Properties

LAN-Caster Client Code Overview

  • startclient.py
  • Client Class
    • init()
    • run()
      • Message Processing
      • Update Screen
      • User Input Event Processing
      • Loop Timing
  • ClientMap Class (intro to map rendering)
  • Subclassing

LAN-Caster Server Code Overview

  • startserver.py
  • Server Class
    • init()
    • run()
      • Message Processing
      • Step Processing
      • Send Steps
      • Loop Timing
  • ServerMap Class (intro to mechanics)
  • Subclassing

LAN-Caster Server Stepping

  • StepMap Class
  • Server Stepping
  • Step Methods used for Game Mechanics
    • initMechanicName(): Called only once when the map is loaded.
    • stepMapStartMechanicName(): Called once at the start of each step.
    • triggerMechanicName(trigger, sprite): Called for every trigger/sprite collision
    • stepMoveMechanicName(sprite): Called for every sprite that is moving
    • stepMapEndMechanicName(): Called once at the end of each step.
  • -verbose server startup messages

LAN-Caster engineTest Explanation (part 1)

  • Player Sprites
  • Move Linear Mechanic (also, intro to collisions)
  • MapDoor Mechanic
  • Holdable Mechanic
  • Rendering (layers, shapes, map size)
  • Text Styles
  • Tile Animation and Character Tiles

LAN-Caster engineTest Explanation (part 2)

  • Triggers and Layer Visibility (Adding a Mechanic)
  • Ways to Show Text
  • Extending a Mechanic
    • PortKey Mechanic
    • Timer Mechanic
  • Sprite Dictionary
  • Advanced Tests

Videos to be added...

Tiled Properties in LAN-Caster

  • Properties can be added in Tiled for:
    • Tileset
    • Tile
    • Map
    • Layer
    • Object
  • How Properties are Loaded
  • Duplicate Properties
  • Accessing Properties (prop-...)

Collisions in LAN-Caster

  • Object collisionType
  • collisionType default by Layer
  • engine.geometry.collides()
    • example collisions
    • overlap
  • Example uses of collides()
    • engine.stepmap.stepTriggers()
    • engine.map.checkLocation()
    • engine.map.findObject()

How To Use User Action Mechanic in LAN-Caster

How To Add User Inputs to LAN-Caster

LAN-Caster Demo Game Overview

  • File structure
  • Maps and Tilesets
  • Tangent: General vs. Hardcoded Design Decisions
  • Demo Server (Global Game Logic)
    • Game Mode (waitingForPlayers, gameOn, gameOver)
    • waitingForPlayers Marquee Text
    • Detecting gameOn
    • GameOn Marquee Text and Player Clearing of Marquee Text
    • Detecting gameOver
    • Tracking Time
    • GameOver Marquee Text
  • Demo Client
    • Fonts

LAN-Caster Demo Game Mechanics

  • Making General vs. Hardcoded Design Decisions
  • Demo ServerMap
    • Chicken,
    • Throw,
    • SpeedMultiplier (mud),
    • Bomb,
    • RespawnPoint mechanics
  • Start Map ServerMap
    • lockedMapDoor
  • Under Map ServerMap
    • Saw
    • Use of RespawnPoint
    • StopSaw
  • Under Map ClientMap
    • Darkness
  • End Map ServerMap
    • Lever
    • Magic Wand