seclerp / oxyengine

:video_game: OxyEngine - 2D full-featured open-source crossplatform game engine

OxyEngine is a full-featured cross-platform 2D game engine that allows you to develop games using C# and Python.

💬	✅	develop	master

---

❗❗❗ Please note: This project in alpha stage of development at that moment. Do not use it for any production projects before first public release will be published. For now, OxyEngine does not guarantee backward compatibility of API and stability of your code.

---

Getting Started

These instructions will get you information to get started with engine.

Prerequisites

Mono

If you are on Linux or MacOS, you need to install Mono SDK for debugging and running .NET executables.

Latest Mono SDK can be found here.

MonoGame

You need to install MonoGame SDK to compile assets and using ready-to-use remplates.

Latest MonoGame SDK can be found here.

Tutorials

You can found tutorials on the wiki page.

Compatibility

Desktop

OxyEngine has only 2 native dependencies for Desktop from MonoGame: OpenAL and SDL2. Both of them are shipped with MonoGame.

More info in first tutorial.

Installing

This section will show you how to install OxyEngine into your .NET project.

From NuGet (preffered)

Latest stable release

Latest release you can find on NuGet.org.

Developer build

Every successful builded commit to develop branch push new nuget package to our custom NuGet feed:

MyGet feed (v3): https://www.myget.org/F/oxyteam/api/v3/index.json

MyGet feed (v2): https://www.myget.org/F/oxyteam/api/v2

After adding feeds, install Oxy.Engine NuGet package.

Building from sources (advanced)

To install stable version of OxyEngine into your .NET Core App:

1. Сlone this repository: git clone https://github.com/OxyTeam/OxyEngine.git Use master branch for only stable and production-ready code. You also can use default branch, but it may be unstable.
2. Select preffered configuration and Build solution.
3. Reference OxyEngine.dll and other dependencies to you project.

Examples

Quick start

Changelog

See CHANGELOG.md for changes.

Built With

OxyEngine uses some third-party libraries and tools:

• MonoGame - One framework for creating powerful cross-platform games.
• IronPython - the Python programming language implementations for the .NET platform.

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use Semantic Versioning for versioning. For the versions available, see the tags on this repository.

Authors

• Andrey Rublyov - Programmer - AndrewRublyov
• Andrey Belyaev - Programmer - Svetomech

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE file for details

Acknowledgments

Big thanks to:

• Love2d team for inspiration for OxyEngine API.
• Guys from MonoGame team for great cross-platform game framework.
• IronLaungages developers for supporting and development of IronPython and other Iron languages.

oxyengine's Issues

Support for matrix transformations

Also need class for Matrix

Support for

• transform
• rotate
• scale

Methods' signature proposal:
void Graphics.PushMatrix()
void Graphics.PopMatrix()
void Graphics.Transform(float x, float y)
void Graphics.Rotate(float r)
void Graphics.Scale(float x, float y)

SetText crush engine with AccessViolationException

Fix this in 0.1.2

Fix README links and TODO

Create configurations for desktop deploy of Oxy.Playground

Setup Continious Integration

Setup Continious Integration using Travis CI

Alt+F4 to close window on Windows

NuGet cannot find OpenTK constrait

Add logging

Add class Debug for logging every error and Engine/Framework resource loading, graphics errors, etc.

Logging into the .txt file and in console (optional)

Configure Doxygen

Configure Doxygen to generate correct documentation for the project

Add documentation to ready-to-use ECS

Add ability to draw only part of IDrawable using RectObject

Make game config support

To setup window and graphics settings, etc

Provide precompiled builds of Playground for Windows, Mac OS X and Linux

Improve font renderer

Improve ugly TextRendrer with something more beautiful

Basic CONTRIBUTING guide needed

Need to create CONTRIBUTING.md

Python lib .nuspec

Create OxyEngine.Python lib .nuspec file

Bitmap font support

Bitmap font will generate Font or (derived class) from Texture and character list

Methods' signature proposal:
Resources.NewBitmapFont(string texturePath, string characters)
Resources.NewBitmapFont(Texture bitmap, string characters)

Finish basic design and skeleton

• Wordpress for tutorials, manuals, pages
• phpBB for forum (mb another one?)

Basic primitive drawing

Support for drawing

• circles
• rectangles
• polygons
• lines
• dots

Using both fill and line modes.

Methods' signature proposal:
Graphics.SetLineThickness(float th)

Graphics.DrawCircle(string style, float x, float y, float r)
Graphics.DrawRectangle(string style, float x, float y, float w, float h)
Graphics.DrawPolygon(string style, params int[] xy)
Graphics.DrawLine(int x1, int y1, int x2, int y2)
Graphics.DrawDot(int x1, int y1)

Optimize dynamic object creation

Replace Activator.CreateInstance with compiled lambda expressions

Make internal classes and ...Objects with internal constructor

To encapsulate classes that not need to be used outside

Fix README

• Fix Nuget link for MyGet feed package
• Fix Nuget link for Nuget.org link
• Fix newline for MyGet v2 and v3

Error window

Add basic error window with stacktrace

Caching of the resources

Add ability to call Load... with caching to not worry about multiply loading

Remove or fix pystdlib

Add support for gamepads

Add support for gamepad input (buttons, sticks)
Create mapping in InputMap and methods in input module (using OpenTK)

Fix and finish basic tutorials on Wiki

Include OpenAL and other native dependencies with release

List of cross libs here

Basic TTF font printing

Also support for default font
Proposal: Verdana

Methods' signature proposal:
Graphics.SetFont(Font font, int size)
Graphics.Print(string text, float x, float y, float r, float sx, float sy)

Create common types for graphics

• Texture
  Types must be implemented in Common project to prevent using modules from each other

Configure AppVeyor to pack dev version for MyGet

Now it only pushes version of the release

Update .md files

README.md

Readme is outdated since we moved from .NET Core -> Mono (plain) -> MonoGame.

• rewrite Getting Started guide and move it to Wiki
• rewrite Installation guide and move it to Wiki
• update information about OxyEngine and OxyPlayground
  • update Built With
  • update Acknowledgments

CROSSLIBS.md

Remove or rewrite

COMPATIBILITY.md

Remove or rewrite

Recursive Python import not working

Window management

Create, gameloop, close

Create solution and projects

Simple structure doc (RU) : https://docs.google.com/document/d/14svMyoi5ujDE_jTRy8oXY3Gbdo6JdTnpOTYsCTjqy3s/edit?usp=sharing

NuGet lib not containing Oxy.Framework lib

Critical bug, there are no Oxy.Framework.dll in the NuGet

Texture loading support

Supported formats:

• png
• jpg
• maybe something else?

Methods' signature proposal:
Texture Resources.LoadTexture(string libraryPath)

Render-to-texture

Add support for rendering into texture

Entity Component System

Implement Entity-Component-System, with basic ready to use:

Entities:

• GameEntity (base class)
• TransformEntity (entity with transform)

Components:

• GameComponent (base class)
• TransformComponent (for position, rotation, scale)
• SpriteComponent (for drawing Texture with Rectangle)
• FigureComponent (for drawing primitives)
  • RectangleComponent
  • CircleComponent
  • LineComponent
  • PolygonComponent
  • PointComponent
• AudioEffectPlayerComponent (for playing audio)
• SongPlayerComponent (for playing ambients)

System:

• GameSystem (base system)
• RenderSystem
• LogicSystem

Allow printing with default font

Default font is Roboto

Basic README needed

Need to create basic README file to describe OxyEngine.

Basic keyboard and mouse input support

Basic support for keyboard and mouse.

Methods' signature proposal:
bool Input.IsKeyPressed(KeyCode key)
bool Input.IsMousePressed(MouseButton key)

Streaming support + support of the formats .mp3, .ogg

Add support for streaming type of AudioObject

Add ability to set origin point for Graphics.Draw

Basic audio support

Add support for basic playing sounds and music (only wav for first time, without audio streaming)

Methods' signature proposal:
AudioObject Audio.NewSource(string fileName, string type)
void AudioObject.SetLoop(bool loop)
void AudioObject.Play()
void AudioObject.Pause()
void AudioObject.Stop()

Generate Python stubs

Generate IronPython stubs for every new version of Engine for auto completion

Integrate Python via IronPython

Using IronPython 2.

We will move to IronPython 3 when it will be stable.

Adapt Oxy.Framework modules to NuGet publishing

Adapt Oxy.Framework modules to NuGet publishing to simplify future integration with CI and publishing to nuget.org.

Tutorial: https://docs.microsoft.com/en-us/nuget/create-packages/creating-a-package

Font loading support

Supported formats:

• ttf
• otf

Methods' signature proposal:
Font Resources.LoadFont(string path, float size)

Basic texture drawing

Also this task include writing default GLSL shader that accepts color and texture

Method signature proposal:
Graphics.Draw(TextureObject texture, float x, float y, float r, float sx, float sy)