Sandro Sobczyński
171 lines
6.7 KiB
Markdown
171 lines
6.7 KiB
Markdown
[![Contributors][contributors-shield]][contributors-url]
|
|
[![MIT License][license-shield]][license-url]
|
|
[](https://discord.gg/NhhTmg3Gm5)
|
|
[](https://discord.gg/7dCr6ThSN5)
|
|
|
|
<br />
|
|
<p align="center">
|
|
<a href="https://github.com/h4570/tyra">
|
|
<img src="http://apgcglz.cluster028.hosting.ovh.net/tyra/github-splash.png" alt="Logo" width="100%" height="auto">
|
|
</a>
|
|
|
|
<h3 align="center">Tyra</h3>
|
|
|
|
<p align="center">
|
|
Open source game engine for PlayStation 2™
|
|
<br />
|
|
<a href="https://streamable.com/k5jr0w"><strong>View Demo »</strong></a>
|
|
<br />
|
|
<br />
|
|
<a href="https://github.com/h4570/tyra/issues">Report Bug</a>
|
|
·
|
|
<a href="https://github.com/h4570/tyra/issues">Request Feature</a>
|
|
</p>
|
|
</p>
|
|
|
|
## Table of Contents
|
|
|
|
* [About the Project](#about-the-project)
|
|
* [Samples](#samples)
|
|
* [Branches](#branches)
|
|
* [About project](#about-project)
|
|
* [Acronyms](#acronyms)
|
|
* [Tyra features](#tyra-features)
|
|
* [Built With](#built-with)
|
|
* [Getting Started](#getting-started)
|
|
* [Prerequisites](#prerequisites)
|
|
* [Installation](#installation)
|
|
* [Roadmap](#roadmap)
|
|
* [Contributing](#contributing)
|
|
* [License](#license)
|
|
* [Tyra team](#tyra-team)
|
|
* [Thanks](#thanks)
|
|
|
|
## About The Project
|
|
|
|
<img src="http://apgcglz.cluster028.hosting.ovh.net/tyra/1.1.0/tyra.gif" alt="sample" width="600" height="auto">
|
|
|
|
### Samples
|
|
* [Dolphin](https://github.com/h4570/tyra/tree/master/src/samples/dolphin)
|
|
* [Floors](https://github.com/h4570/tyra/tree/master/src/samples/floors)
|
|
|
|
### Branches
|
|
* Master - monthly releases
|
|
* Develop - daily builds. **Please use this at this moment**
|
|
|
|
### Contributors wanted
|
|
#### I will be grateful for any help, Discord: h4570#3402
|
|
|
|
### About project
|
|
Goal of Tyra project is to provide simple API for PS2 game creation, so you can just run PS2 emulator, grab .obj file, and put it into live in a seconds. Project is on early stage, so a lot of stuff is changing from release to release.
|
|
|
|
YouTube tutorials soon!
|
|
|
|
**Why Tyra is needed?** Raw PS2 development can be a big challenge. PS2 it's pretty low-level and there are a lot of stuff that you must do from scratch.
|
|
Tyra takes care for you, and rendering, coprocessors communication and many more low-level stuff is already done.
|
|
|
|
### Acronyms
|
|
* EE (Emotion Engine) - whole set of processors and subsystems that make up the PlayStation 2
|
|
* GS (Graphic synthesizer) - configurable rasterizer and texture mapper. Has only 2MB~ memory for textures, but for the opposite have very high transfer rate, so you can switch textures in the blink
|
|
* VU0 - programmable (ASM) vector processor that is accessed by inline assembly code injected into C program.
|
|
* VU1 - programmable (ASM) vector processor, which is similar to vertex shader. Accessed via DMA.
|
|
* IOP - I/O processor which enables access to peripheral devices, such the game controller
|
|
|
|
### Tyra features
|
|
* 3D support - VU1 "Path 1 rendering"
|
|
* Frustum culling, backface culling
|
|
* OpenGL adaptions: Frustum projection, lookAt camera
|
|
* Texture support - .bmp and png
|
|
* Mesh loaders: ".obj", ".dff" (RenderWare, GTA:SA) and ".md2" (Quake II)
|
|
* Threading support
|
|
* Animation support for obj and md2
|
|
* Audio support - .wav and .adpcm
|
|
* Pad support
|
|
|
|
### Built With
|
|
|
|
* [PS2SDK](https://github.com/ps2dev/ps2sdk)
|
|
|
|
## Getting Started
|
|
|
|
[](https://discord.gg/NhhTmg3Gm5)
|
|
In our Discord channel, there is detailed tutorial which will help you with setting up the all environment - starting from installing dependencies and ending on emulator setup or intellisense.
|
|
|
|
### Prerequisites
|
|
|
|
This is an example of how to list things you need to use the software.
|
|
* PS2 DEV environment - [PS2DEV](https://github.com/ps2dev/ps2dev)
|
|
* At least #674b6f4 PS2SDK (01.12.2020) - [PS2SDK](https://github.com/ps2dev/ps2sdk)
|
|
* PS2 Emulator. For example [PCSX2](https://pcsx2.net/)
|
|
|
|
### Installation
|
|
|
|
1. Clone the repo
|
|
```sh
|
|
git clone https://github.com/h4570/tyra.git
|
|
```
|
|
2. Get into src folder and compile it!
|
|
```sh
|
|
cd src/samples/floors
|
|
make rebuild-engine
|
|
make
|
|
```
|
|
|
|
## Extra info
|
|
* BMP loader needs some polishing soe be sure that you exporting BMP with 24bit: RGB888 and without information about colors.
|
|
* If you want to run .elf in PCSX2, be sure that you have version >=1.6 and **Host access** enabled in PCSX2 configuration file.
|
|
* If you want to use your own .obj file, please check "triangulate faces" in blender. PS2 is supporting only triangle primitive type.
|
|
|
|
## Roadmap
|
|
|
|
### Roadmap for next master release:
|
|
[https://github.com/h4570/tyra/projects/1](https://github.com/h4570/tyra/projects/1)
|
|
|
|
|
|
See the [open issues](https://github.com/h4570/tyra/issues) for a list of proposed features (and known issues).
|
|
|
|
## Contributing
|
|
|
|
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
|
|
|
|
1. Fork the Project
|
|
2. Create your Feature Branch (`git checkout -b feature/amazing-feature`)
|
|
3. Commit your Changes (`git commit -m 'Add some amazing-feature'`)
|
|
4. Push to the Branch (`git push origin feature/amazing-feature`)
|
|
5. Open a Pull Request
|
|
|
|
## License
|
|
|
|
Distributed under the Apache License 2.0 License. See `LICENSE` for more information.
|
|
|
|
## Tyra team
|
|
|
|
Sandro Sobczyński - sandro.sobczynski@gmail.com
|
|
[![LinkedIn][linkedin-shield]](https://linkedin.com/in/sandro-sobczyński-28820b15a)
|
|
Michał Mostowik - mostek3pl@gmail.com
|
|
[![LinkedIn][linkedin-shield]](https://www.linkedin.com/in/notfoxar)
|
|
|
|
## Thanks
|
|
|
|
Without these guys, everything would be harder:
|
|
* Dr Henry Fortuna - for code sources
|
|
* Rick Gaiser - for help and new GCC!
|
|
* Lukasz D.K. - for huge archive of PS2 stuff-
|
|
* Guilherme Lampert - for code sources
|
|
* Jesper Svennevid, Daniel Collin - for openvcl's code samples
|
|
* Whole PS2DEV team
|
|
* And so many other guys. Thanks!
|
|
|
|
Project Link: [https://github.com/h4570/tyra](https://github.com/h4570/tyra)
|
|
|
|
<br />
|
|
<a href="https://github.com/h4570/tyra">
|
|
<img src="http://apgcglz.cluster028.hosting.ovh.net/tyra/github-splash2.png" alt="Logo" width="100%" height="auto">
|
|
</a>
|
|
|
|
[contributors-shield]: https://img.shields.io/github/contributors/h4570/tyra.svg?style=flat-square
|
|
[contributors-url]: https://github.com/h4570/tyra/graphs/contributors
|
|
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=flat-square&logo=linkedin&colorB=555
|
|
[license-shield]: https://img.shields.io/github/license/h4570/tyra.svg?style=flat-square
|
|
[license-url]: https://github.com/h4570/tyra/blob/master/LICENSE
|