Terasology
  • Project Overview
    • Codebase-Structure
    • Sites
    • GitHub Organizations
    • External Projects
    • History and more
  • Getting Started
    • Quick Start
    • Light Workspace Setup
      • Using the GitHub Web Interface
        • Creating a Fork
        • Creating and Deleting Branches
        • Editing
        • Opening a Pull Request
      • Using the GitHub Desktop Client
        • Setting Up the Client
        • Cloning Your Repository
        • Creating a Branch
        • Making Changes and Committing
        • Opening Pull Requests
    • Full Workspace Setup
      • Requirements
      • Run game from source
      • IntelliJ
      • Eclipse
      • Git
    • Using IRC
      • IRC User Setup
      • Gooey
    • Common Issues
      • Game
      • IntelliJ
      • Java
      • Linux
      • Arch/Gentoo random problems
  • Concepts
    • Block World
    • Entity System
      • Entities and Components
      • Component Systems
      • Events
    • Asset System
      • Prefabs
    • Modules
      • Structure of Modules
      • module.txt
      • Namespace
      • Guides
    • Networking and Multiplayer
  • Developer Guides
    • Blocks
      • Block Definition
      • Accessing Blocks
      • Block Attributes
        • Inheritance
        • Informational
        • Core behavioural
        • Tiles
        • Rendering Options
        • Color Lookup Tables
        • Shapes and Rotation
        • Collisions
        • Physics
        • Entity System Integration
        • Inventory Settings
        • Categories
      • Shapes
        • Block Shape Basics
        • Shape Parts
        • Colliders
        • Shape Example
      • Block Shapes In Blender
        • Block Shape Addon Installation
        • Fundamentals
        • Tips When Creating A Shape
        • Terasology Exporter Addon Properties
        • Block Shape Video Tutorial
      • Block Families
    • Entity System
      • Events
        • Defining events
        • Sending events
        • Processing events
        • Consumable events
      • Dependency Injection
        • Inject an Instance
        • Share a Class
        • How it works
      • Commands
        • Command structure
        • Annotation and Command Name
        • Short Descriptions and Help Text
        • Displaying Text
        • Parameters
        • Commands and Multiplayer
    • Modules
      • Terasology’s Git Setup
      • Fetching existing Modules
      • Create a new Module
      • Dependency Resolution
      • Modding API & Sandboxing
    • Networking and Multiplayer
      • Entities, Components on the Network
        • Replicate annotation
        • Network Component
      • Network Events
        • ServerEvent
        • BroadcastEvent
        • OwnerEvent
    • User Input
      • Define Bindings
      • Input Categories
      • Handling Input Events
    • Translation
      • Internationalization / i18n
      • Localization / l10n
        • Using Weblate
        • Manual Translation
  • Conventions and Workflow
    • Contributing
      • Creating a Fork
      • Updating a Fork
      • Creating a Pull Request
      • Direct Write Access
    • Versioning
      • Snapshots
      • Making a Release
    • Documentation (JavaDoc)
      • General Formatting
      • First Sentence
      • HTML Tags
      • Block Tags
        • @code and @link
        • @param, @return, and @throws
        • @author
      • What to Document
        • Public and Protected
        • null-tolerance, Pre- and Postconditions
      • Generate HTML JavaDoc
    • Documentation (External)
      • Sphinx Documentation
        • Directory Structure
        • Headlines
        • JavaDoc Links
        • External Links
        • Code Snippets
    • Unit Testing
      • Why Tests?
      • Testing Libraries
      • Guidelines for Tests
      • Game Environment Tests
  • Playing
    • Controls
    • Console
    • Server Hosting
  • JavaDoc (External)
Terasology
  • Docs »
  • Conventions and Workflow
  • Edit on GitHub

Conventions and Workflow¶

  • Contributing
    • Creating a Fork
    • Updating a Fork
    • Creating a Pull Request
    • Direct Write Access
  • Versioning
    • Snapshots
    • Making a Release
  • Documentation (JavaDoc)
    • General Formatting
    • First Sentence
    • HTML Tags
    • Block Tags
      • @code and @link
      • @param, @return, and @throws
      • @author
    • What to Document
      • Public and Protected
      • null-tolerance, Pre- and Postconditions
    • Generate HTML JavaDoc
  • Documentation (External)
    • Sphinx Documentation
      • Directory Structure
      • Headlines
      • JavaDoc Links
      • External Links
      • Code Snippets
  • Unit Testing
    • Why Tests?
    • Testing Libraries
    • Guidelines for Tests
    • Game Environment Tests
Next Previous

© Copyright 2017, Terasology.

Built with Sphinx using a theme provided by Read the Docs.