Skip to content

Latest commit

 

History

History
62 lines (45 loc) · 2.42 KB

DESCRIPTION.md

File metadata and controls

62 lines (45 loc) · 2.42 KB
Raw

Description

Create general editors for 2D tiled games.

Philosphy

The purpose of this project is to provide an API that can serve as a base for creating editors for 2D tilemap-baed games. This API aims to

  • Create a general Editor class that supports common functions like undo/redo, cut, copy, and paste, selecting and deleting, and opening and saving form and to files.
  • Create classes that work with common TileMap designs that are seen throughout these 2D games.
  • Create IEnumerable classes that iterate through special selections of tilemap data such as boxes, lines, and custom regions.

Open Source

This project is being built with the goal of being completely open source, and enforcing all programs that use it be open source too. Open source allows anyone to contribute, fix, and improve the project at any time. It also allows anyone to use the project for their own purposes.

For more information on the value of open source, read the Open Source Guide.

Cross platform

In conjunction with open source, being cross platform is an essential component of this project; it should be accessible to anyone on any OS. Making cross-platform projects also becomes easier for open source projects where users with different setups can contribute.

Full documentation

Sometimes, the biggest challenge of contributing to a new project is understanding what all of the code does. For this reason, it is our philosophy that every function, module, and component be documented and outlined, and have relevant example code to show users how its used and why. We utilize the Sandcastle Help File Builder (SHFB) to build the documentation. SHFB uses formatted comments in source code files to build documentation pages in many formats, including HTML, Markdown, and Windows Help File.

Community driven environment

Please follow the Code of Conduct for a more detailed explanation of working in a community project.

Accessibility

Follow the guideilines provided in Microsoft's Globalization and localizing .NET applications. As a quick and general rule, be sure to

  • Use resource files in place of hardcoded strings.
  • Use culture-specific settings where appropriate.
  • Handle dates and times according to the user's locale.