h4570/tyra

Game engine for PlayStation 2™

• C++ - Tyra, libpacket2 in PS2SDK, QNX game for Audi, GTA:SA Trainer
• C# - ingoodhands, Design patterns, Armnas, Crackmes, SPK
• Angular - Armnas, ingoodhands
• Other web - Pathfinding, Network calculator, Neural network
• Java, PHP, C# - University

tyra's Issues

New CameraBase

CameraBase needs refactoring, so far I noticed the following needs to be done:

• Change p_position and p_up Vector3 pointers to normal Vector3 variables, and adjust the constructor for it.
• Make the class abstract (?)

audio.setSongVolume() doesnt work if set before playSong()

Problem seems to be here.

tyra/src/engine/modules/audio.cpp

Line 82 in d58163d

void Audio::setSongVolume(const u8 &t_vol)

Add support for PS2 fog

Dolphin: Fast collecting oysters cause ADPCM crash

When you will try to collect oysters quickly, there is big chance to get ADPCM channel used error.

Rename mesh_material to mesh_subgroup

I feel like mesh_material is an incorrect name for the class considering that it is responsible for mesh data of sub-parts of another, bigger mesh.

Repo description

I don't quite think labeling tyra as a "renderer" does it justice. It manages model loading, sound playing, I/O for the controllers and we plan to add more, with renderer being only a part of it. @h4570

I suggest we change the description to not incude the 'renderer' part as it implies it's only that. "Game engine" or "Multimedia library" or such would be more accurate.

Concentrate all method's definitions in the .cpp files of their respective class

I'm not sure why some methods are defined within the header files while some in the cpp files of some classes. Good example is
mesh_frame.hpp
void setVertexFace(const u32 &t_index, const u32 &t_val) { vertexFaces[t_index] = t_val; }
void setSTFace(const u32 &t_index, const u32 &t_val) { stFaces[t_index] = t_val; }
void setNormalFace(const u32 &t_index, const u32 &t_val) { normalFaces[t_index] = t_val; }

I understand they are short and possibly self-explanatory from the name, but perhaps it'd be better to concentrate all definitions of a given class in one file to make finding definitions a bit easier. Need your opinion on it @h4570

Move into GCC11!

I did some tests through latest months, and from what I see, we can securely move to GCC11! :)

Enable rendering of meshes without textures / normals data.

Currently the renderer, as far as I'm aware is not capable of rendering texture or normals data. It'd be beneficient to allow such, limiting crashing and allowing to test models within Tyra without having to provide full set of data for them.

Floors sample rework

Floors sample need some polishing, because its good proof of concept, but its not look like real game.

• Add game goal
• Fix animations
• Fix player vs camera rotation
• Add some 2D stuff

tyra/src/samples/floors/floors.hpp

Line 23 in d58163d

class Floors : public Game, AudioListener

Add assert(), remove PRINT_ERR()

• Use assert() in default Makefile task
• Add second make task "release" to Makefile which will be NOT using assert()
• Replace all PRINT_ERR() with assert()
• Add optional string parameters to assert(), so there will be possible to do something like assert(file != NULL, "File: ", file.name, " cant be null!");

Refactor BBox constructors

Current bbox constructors are real mess.

I wondered about

• static CoreBBox createByA()
• static CoreBBox createByB()
• ...

functions, to keep it more clear

Add CI & Static code analysis

I think that it will be useful to have some static code analysis on PR stage

Add Math::abs()

We need to check it if abs() is needed in math class.
From what I remember, abs() function is in fastmath.h.

tyra/src/engine/include/utils/math.hpp

Line 23 in d58163d

class Math

Add "starter" sample

I think that there will be good idea to add "starter" sample, which should be an easy start with Tyra.

Add collision functions to bounding box

Foxar:
"I think it is a good idea, to add some functions like contains() intersect() to bounding box class.

Check for possible "const &" and "inline" improvements.

I'm sure that many of getters/setters can have better performance by simply add inline keyword.
Also many of functions (math.cpp, vifsender.cpp, ...) do not have const & parameters where it should be.

Examples of lack of inline:

tyra/src/engine/include/models/mesh_frame.hpp

Line 37 in 3e385f7

const u32 &getVertexCount() const { return vertexCount; };

tyra/src/engine/include/models/mesh_frame.hpp

Line 82 in 3e385f7

Vector3 *getBoundingBox() { return boundingBox; };

Examples of lack of const &:

tyra/src/engine/include/models/math/vector3.hpp

Line 34 in 3e385f7

Vector3(float t_x, float t_y, float t_z);

Add stopAudio() to audio class.

Current problem is that, we cant really stop the ADPCM sample.
I wonder, that we can add wrapper to audsrv_stop_audio() in our audio class.
We need some check how this function works, and how we can use it in audio class.

Add origin getters setters to mesh/sprite

@Foxar please describe the plan if you could.

Lighting support in draw()

Currently lighting is supported only in drawByPath3(), which have low performance and triangle clipping glitches.

Need to implement lighting in VU1 code (.vcl) file

Resolve all of the GCC11 errors/warnings

Migration from the GCC 3.2.3 to GCC11 brought to us many compilation errors/warnings/suggestions. It is a good idea to resolve them all

Add renderer.drawLine() (3D)

Add drawLine() to renderer.
Can be usefull for debugging purposes.

2D sprites tile by default instead stretching

Commit that possibly broke it: #30

After I pulled the develop branch to my fork today I've discovered that the fullscreen sprite I'm using for underwater swimming tiles, instead of stretching.

It now looks like this:

@h4570 Please elaborate on if this is meant to be the default behavior and if so, can sprites be made to stretch instead of tiling?

Allow arguments of volume and pitch to be used for ADPCM player.

Right now, if I want a sound to play at a specific volume, I have to go the long winded way of doing:

audio.setADPCMVolume(40, 2);
audio.playADPCM(sound, 2);

This also means the channel 2 will stay at volume 40, forcing the user to either:

• Always set the volume they desire for the sound effect or
• Creating some timer-based channel volume resets to 100.

I think either enabling the user to designate the volume (and pitch maybe) while using playADPCM() could simplify the first option, while also the timed mechanism i spoke of can also be introduced to Tyra.

I believe it's a good idea as Tyra's meant to be a simple way to make PS2 games, and such an automatic volume reset (opt2) / consolidation of parameter setting (opt1) may simplify the process.

Fix triangle clipping in drawByPath3()

Currently drawByPath3() is generating some weird glitches, when mesh is partially outside of view frustum.
This is probably issue which should be in PS2SDK, but I will leave it there.

Line in PS2SDK which propably cause the glitching

Using in:

tyra/src/engine/modules/gif_sender.cpp

Line 217 in d58163d

calculate_vertices(vertices, vertexCount, vertices, localScreen);

PRINT_ERR String formatting

If we'd allow for syntax similar to printf and feeding variable values into PRINT_ERR it could allow for more informative error messages
Example:
PRINT_ERR("Failed to load file %s!\n",someString)

Display text on screen with a function.

There's none function to write text on screen with coordinates without adding a UI.

Create "Dolphin" sample

Dolphin sample TO-DO (might be changed later)

• Animated water(mesh,code)
• Collectible (mesh,code)
• Seabed (mesh,code)
• Readme

Background music bug on real PS2 (slow, flickering sound)

This issue is related to:

tyra/src/engine/modules/audio.cpp

Line 182 in 7b2e411

// TODO - bug here, GCC11 is doing some optimizations and this method probably think that

GCC11 is doing some optimizations and after porting from GCC 3.2.3 background music stopped working.
I've added some dirty fix, so now sound is working on PCSX2, but there is still problem on real hardware.

Create file service

Create file service which will work in other thread and receive "tasks" for reading certain files partially (read chunk) or completly.
Read chunk by chunk will be great for audio class. Next chunks of song data will be loaded in background, so there will be no "wait" in audio thread. Sometime's song is freezing for couple of miliseconds on real PS2, because of file loading.

tyra/src/engine/modules/file_service.cpp

Line 90 in 3e385f7

void FileService::threadLoop()

tyra/src/engine/modules/audio.cpp

Line 208 in 3e385f7

chunkReadStatus = fread(wavChunk, 1, sizeof(wavChunk), wav);

Add local and global rotation for sprite and mesh

@Foxar please describe the feature if you could.

Add multiple track mixing for audio

To allow multiple songs to be played (for instance, soundtrack and an ambient).

Refactor all dynamic allocations to smart pointers

Nothing to say more :D

Contributing document

Since as I expect we will have soon more developers on the project, I suggest we create a Contributions/Rules of conduct document.

Implement triangle clipping algorithm for big triangles. (Renderer, VU1)

Triangle clipping is not that broken like in drawByPath3() , but this need also some polishing.
When triangle is big and its partially outside of view frustum, we can see some weird behavior, that whole triangle is discarded.

tyra/src/engine/vu1_progs/draw3D.vcl

Line 43 in d58163d

fcset 0x000000 ; VCL won't let us use CLIP without first zeroing

tyra/src/engine/vu1_progs/draw3D.vcl

Line 104 in d58163d

clipw.xyz vertex, vertex ; Dr. Fortuna: This instruction checks if the vertex is outside

Static code analysis, C++ lint

I think that we can add CI to Tyra pull reqeuests, including:

• Static code analysis
• C++ lint check
• Building all of the tutorials + demo

It should not be super hard, because we have cooked docker image

Add 2D font support

There are two ways of doing this.

1. Use PS2SDK font library, but this will require for us impress.ini file which is not present in PS2SDK.

2. Better option - do it similiar like in gsKit, but this require more effort

Lighting in drawByPath3() doesn't work on REAL PS2

Problem seems to be here.

tyra/src/engine/modules/gif_sender.cpp

Line 199 in d58163d

colors[i][1] = (t_mesh.color.g * lights[i][1] / 128.0F);

Lighting works on emulator, but not work on real PS2 hardware.

Improve BMP loader

Currently BMP loader does not give any feedback about wrong file.

• Add 24bit check
• Add auto skipping of color information header.

tyra/src/engine/include/loaders/bmp_loader.hpp

Line 19 in d58163d

class BmpLoader

Add build tutorial

I'm wondering about some tutorial in .md format, where will be described:

• How to build PS2SDK for Tyra.
• How to build Tyra.
• How to build samples.
• How unpack samples assets.
• What to do in PCSX2 to make Tyra samples running.

Add RigidBody physics

The huge one.
I don't have exact plan for that one, but I will leave it there,

Change way of ID generation

Currently id numbers are generated via random() function which is really bad.
Probably we can implement 3rd-party lib or just increment it in separated class.

Change AABB (bounding box) from array to struct

@Foxar please describe the plan if you could.

tyra/src/engine/include/models/mesh_frame.hpp

Line 142 in d58163d

Vector3 boundingBox[8];

Add information about PCSX2 "hostfs=enabled"

Tyra loads at the beginning AUDSRV.IRX module.
When user have not "hostfs" set, this module will not be loaded (loading error).
It will be nice to have more clear error message there.
Maybe something like "First module loading failed. If you are using PCSX2, be sure that you have hostfs=enabled and assets files, are present in bin/ folder"

Dolphin: Deep diving causes a game freeze

When you will deep dive on dolphin sample, game will freeze.
Can be reproduced on PCSX2 and PS2

Include deltatime-based behavior in engine classes

Currently, the games built with Tyra need to manage the delta-time usage themselves. This means moving an object by speed * 60/currentFPS, to achieve a FPS-independent movement. I had an idea to introduce methods to classes like mesh.cpp whereby changes to their member variables would automatically be influenced by deltatime. Such as mesh::moveByDeltaTime(Vector3);

The plus side is it'd make it easier to create game with Tyra, having automated that process. The minus is it might be considered bloat and unnecessary as developers might have different ideas in mind for how to handle their physics and ignore such methods entirely.

I need your opinion, @h4570

Add untextured rendering (RGBA only) to 2D sprite

Currently, tyra supports only textured RGBA texture. Probably untextured sprite also will be usefull.

tyra/src/engine/include/models/sprite.hpp

Line 21 in 3e385f7

class Sprite

Animations rework

@Foxar please describe the plan if you could.

• Add stopAnimation()
• Add isAnimating()
• Create array of animation structs. Like playAnimation("jump")

tyra/src/engine/include/models/mesh.hpp

Line 204 in d58163d

AnimState animState;

[Tyrav1/2]mprove renderware´s diff and add txd support using aap´s library

Well, i´m thinking to do a new upgrade on renderware files using a library developed by aap called librw
follow the link here: https://github.com/aap/librw

Improve obj loader

@Foxar please describe the needs if you could.

tyra/src/engine/include/loaders/obj_loader.hpp

Line 18 in d58163d

class ObjLoader