https://github.com/p0ryae/trs_24
đ An OpenGL-Powered Game Engine in Rust (OpenGL 2.0+)
https://github.com/p0ryae/trs_24
android engine game-development game-engine gamedev gameengine opengl opengl2 opengles rust trs-24
Last synced: 8 days ago
JSON representation
đ An OpenGL-Powered Game Engine in Rust (OpenGL 2.0+)
- Host: GitHub
- URL: https://github.com/p0ryae/trs_24
- Owner: p0ryae
- License: apache-2.0
- Created: 2023-11-09T04:38:44.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-08-11T20:12:08.000Z (8 months ago)
- Last Synced: 2025-03-27T18:11:46.722Z (26 days ago)
- Topics: android, engine, game-development, game-engine, gamedev, gameengine, opengl, opengl2, opengles, rust, trs-24
- Language: Rust
- Homepage:
- Size: 19.9 MB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE-APACHE
Awesome Lists containing this project
README
# TRS_24
[](https://crates.io/crates/trs_24)
[](https://crates.io/crates/trs_24)
[](https://docs.rs/trs_24/latest/trs_24/)
An OpenGL-Powered Game Engine in Rust (OpenGL 2.0+)
## Features
- **Multidimential**: Supports both 3D and 2D rendering.
- **Performance**: Engineered for optimal performance.
- **Cross-Platform**: Supports Windows, MacOS, Linux, and Android builds.
- **OpenGL 2.0 API**: Opens door for diverse GPU/iGPU compatibility.
- **Bundler (WIP)**: Built-in bundling system for Windows, MacOS, Linux, and Android.
## Getting Started
Fundamentally, using two files is the ideal approach for using the engine. Primary file `lib.rs` solely used for running the window on Android and building a shared object (*.so).
Secondary file `main.rs` solely used for testing purposes on the host machine, and building for **Non-Android platforms. Both of these files need to be in the `src` directory.
For both of these files to co-exist, the following needs to be in `Cargo.toml`:
```toml
[lib]
# Causes the production of a dynamic system library
crate-type = ["cdylib"]
[[bin]]
name = "test"
path = "src/main.rs"
```
Both files will have their own respectable structure:
- Structure for `lib.rs`:
> [!NOTE]
> Notice the necessity of `#![cfg(target_os = "android")]` at the first line, and the `#[no_mangle]` attribute before the `android_main` function.
> They NEED to exist, otherwise you'll run to errors and crashes for compliation and building, respectively.
```rust
#![cfg(target_os = "android")]
use trs_24::overture::*;
#[no_mangle]
pub fn android_main(app: AndroidApp) {
// Creates an event loop for android platforms only.
let event_loop = EventLoopBuilder::new().with_android_app(app).build();
// The rest of your code here...
// 99% of the time, this is the place for the content of the
// main function in main.rs, excluding the event_loop definition
}
```
- Structure for `main.rs`:
```rust
use trs_24::overture::*;
pub fn main() {
// Creates an event loop for non-android platforms only.
let event_loop = EventLoopBuilder::new().build();
// The rest of your code here...
}
```
âšī¸ To try and view a fully complete example, clone the repository and head to the `example` directory.
## Build & Bundle
Full instructions for **Android** and **Non-Android** target platforms are within the wiki page [Build & Bundle](https://github.com/p0ryae/TRS_24/wiki/Build-&-Bundle).