Add more better readme

README.md

@@ -1,23 +1,36 @@
+# Li-Ri is a GPL arcade game about toy wooden train
+## Description
 Li-Ri is a fork of Ri-li (http://www.ri-li.org).
 
-Li-Ri is a arcade game licensed under the GPL (General Public License).
-You drive a toy wood engine in many levels and you must collect
-all the coaches for win. You can download it and play indefinitely.
-It's Free. You can play on 'Windows', 'Linux', 'Mac OsX', 'Android'.
+Li-Ri is an arcade game licensed under the GPL (General Public License).
+You drive a toy wooden train on many levels and you must collect all the wagons on map for win. This game is free, and is available on the following platforms: 'Windows', 'Linux', 'MacOS', 'Android'.
 
-Full-featured,
+## Features
 - 19 languages: Arabic, Breton, Chinese, English, Esperanto, French,
   German, Italian, Japanese, Korean, Portuguese, Russian, Slovak,
   Spanish, Swedish, Polish, Turkish, Hungarian, Dutch.
 - Colorful animated wood engine.
 - 50 levels in this first version
 - 3 beautiful musics and many sound effects.
 
+## Screenshots
 ![Main menu](fastlane/metadata/android/en-US/images/sevenInchScreenshots/01.png)
+Main menu
 
 ![Gameplay](fastlane/metadata/android/en-US/images/sevenInchScreenshots/03.png)
+Gameplay
 
-This version updates the version to the SDL2 and updates the code to build and run on Android too.
+## Building
+Information on how to compile Li-Ri is available in the INSTALL file
+
+-------------
+
+Copyright (c) 2023
+Johnny Jazeix: port to SDL2 + android + cmake
+
+Copyright (c) 2006
+Dominique Roux-Serret: roux-serret@ifrance.com : design & programming & graphics & website.
+Maf464 : musics
 
 [<img src="https://fdroid.gitlab.io/artwork/badge/get-it-on.png"
      alt="Get it on F-Droid"

src/audio.cc

@@ -33,7 +33,7 @@
 /*** Variable globales ***/
 /*************************/
 extern sNewPreference Pref;
-extern int Horloge;
+extern int currentTime;
 
 /*** Constructeur et Destructeur ***/
 /***********************************/
@@ -162,10 +162,10 @@ void Audio::Play(eSon So)
     }
 
     if (So == sClic) {
-        if (Horloge - MemoHorloge <= 120) {
+        if (currentTime - MemorizedTime <= 120) {
             return;
         }
-        MemoHorloge = Horloge;
+        MemorizedTime = currentTime;
     }
 
     Mix_PlayChannel(-1, Son[So], 0);

src/audio.h

@@ -66,7 +66,7 @@ class Audio
     /*** Variables ***/
     int N { 0 }; // Nombre d'échantillon audio
     int NMus { 0 }; // Numéro de la music en cours
-    int MemoHorloge { 0 }; // Mémorise l'horloge pour les clics
+    int MemorizedTime { 0 }; // Mémorise l'horloge pour les clics
     Mix_Chunk **Son { nullptr }; // Pointe sur les sons
 };
 

src/editor.cc

@@ -43,8 +43,8 @@ extern SDL_Renderer *sdlRenderer;
 extern Sprite *Sprites;
 extern sNewPreference Pref;
 
-extern int Horloge;
-extern int HorlogeAvant;
+extern int currentTime;
+extern int previousTime;
 
 extern Level level;
 
@@ -62,10 +62,10 @@ eMenu Editor::SDLMain(int NumNiv)
 
     NumN = NumNiv;
 
-    Affiche(); // Charge le tableau
+    Draw(); // Charge le tableau
     SDL_RenderPresent(sdlRenderer);
 
-    Horloge = SDL_GetTicks(); // Prend l'horloge
+    currentTime = SDL_GetTicks(); // Prend l'horloge
 
     Option = rail;
 
@@ -82,7 +82,7 @@ eMenu Editor::SDLMain(int NumNiv)
             switch (event.type) {
             case SDL_WINDOWEVENT:
                 if (event.window.event == SDL_WINDOWEVENT_ENTER) {
-                    Affiche();
+                    Draw();
                 }
                 break;
             case SDL_KEYDOWN:
@@ -173,10 +173,10 @@ eMenu Editor::SDLMain(int NumNiv)
             case pluscourt:
                 level.T[NumN].T[cy * LT + cx] = C_Reduit;
                 break;
-            case vitesse:
+            case speed:
                 level.T[NumN].T[cy * LT + cx] = C_Speed;
                 break;
-            case vie:
+            case life:
                 level.T[NumN].T[cy * LT + cx] = C_Live;
                 break;
             case (e_Sprite)(locomotive + D_Top):
@@ -193,12 +193,12 @@ eMenu Editor::SDLMain(int NumNiv)
         }
 
         // Gère les Horloges et la pose
-        HorlogeAvant = Horloge;
-        Horloge = SDL_GetTicks();
+        previousTime = currentTime;
+        currentTime = SDL_GetTicks();
         Sleeping();
 
         // Fait l'affichage
-        Affiche();
+        Draw();
         SDL_RenderPresent(sdlRenderer);
 
     } while (true);
@@ -208,7 +208,7 @@ eMenu Editor::SDLMain(int NumNiv)
 
 /*** Charge un tableau ***/
 /*************************/
-void Editor::Affiche() const
+void Editor::Draw() const
 {
     int i, x, y, m, cx, cy;
     unsigned char *T;
@@ -217,7 +217,7 @@ void Editor::Affiche() const
     T = level.T[NumN].T;
 
     // Fabrique le fond du jeu
-    Sprites[fond].Affiche(400, 300, 0);
+    Sprites[fond].Draw(400, 300, 0);
 
     // Affiche le circuit
     for (i = 0; i < LT * HT; i++) {
@@ -241,52 +241,52 @@ void Editor::Affiche() const
                 m += 1;
             }
 
-            Sprites[rail].Affiche(x, y, NumRail[m]);
+            Sprites[rail].Draw(x, y, NumRail[m]);
         }
     }
 
     // Affiche les décorations
     for (i = 0; i < level.T[NumN].NDeco; i++) {
-        Sprites[deco].Affiche(level.T[NumN].Deco[i].x, level.T[NumN].Deco[i].y, level.T[NumN].Deco[i].NumSpr);
+        Sprites[deco].Draw(level.T[NumN].Deco[i].x, level.T[NumN].Deco[i].y, level.T[NumN].Deco[i].NumSpr);
     }
 
     // Affiche numero du niveau
-    AfficheChiffre(740, 130, NumN + 1);
+    DrawNumber(740, 130, NumN + 1);
 
     // Affiche les options
     for (i = 0; i < LT * HT; i++) {
         switch (T[i]) {
         case C_Wagon: // Si un loco
-            Sprites[wagon].Affiche(i % LT * D_Case + D_Case / 2, i / LT * D_Case + D_Case / 2, 25);
+            Sprites[wagon].Draw(i % LT * D_Case + D_Case / 2, i / LT * D_Case + D_Case / 2, 25);
             break;
         case C_Allonge: // Si plus long
-            Sprites[pluslong].Affiche(i % LT * D_Case + D_Case / 2, i / LT * D_Case + D_Case / 2, 25);
+            Sprites[pluslong].Draw(i % LT * D_Case + D_Case / 2, i / LT * D_Case + D_Case / 2, 25);
             break;
         case C_Reduit: // Si plus court
-            Sprites[pluscourt].Affiche(i % LT * D_Case + D_Case / 2, i / LT * D_Case + D_Case / 2, 25);
+            Sprites[pluscourt].Draw(i % LT * D_Case + D_Case / 2, i / LT * D_Case + D_Case / 2, 25);
             break;
         case C_Speed: // Si plus vite
-            Sprites[vitesse].Affiche(i % LT * D_Case + D_Case / 2, i / LT * D_Case + D_Case / 2, 25);
+            Sprites[speed].Draw(i % LT * D_Case + D_Case / 2, i / LT * D_Case + D_Case / 2, 25);
             break;
         case C_Live: // Si une vie
-            Sprites[vie].Affiche(i % LT * D_Case + D_Case / 2, i / LT * D_Case + D_Case / 2, 25);
+            Sprites[life].Draw(i % LT * D_Case + D_Case / 2, i / LT * D_Case + D_Case / 2, 25);
             break;
         }
     }
 
     // Affiche le départ de la locomotive
     switch (level.T[NumN].DepDir) {
     case D_Top:
-        Sprites[locomotive].Affiche(level.T[NumN].DepX * D_Case + D_Case / 2, level.T[NumN].DepY * D_Case + D_Case / 2, 0);
+        Sprites[locomotive].Draw(level.T[NumN].DepX * D_Case + D_Case / 2, level.T[NumN].DepY * D_Case + D_Case / 2, 0);
         break;
     case D_Bottom:
-        Sprites[locomotive].Affiche(level.T[NumN].DepX * D_Case + D_Case / 2, level.T[NumN].DepY * D_Case + D_Case / 2, 40);
+        Sprites[locomotive].Draw(level.T[NumN].DepX * D_Case + D_Case / 2, level.T[NumN].DepY * D_Case + D_Case / 2, 40);
         break;
     case D_Left:
-        Sprites[locomotive].Affiche(level.T[NumN].DepX * D_Case + D_Case / 2, level.T[NumN].DepY * D_Case + D_Case / 2, 80);
+        Sprites[locomotive].Draw(level.T[NumN].DepX * D_Case + D_Case / 2, level.T[NumN].DepY * D_Case + D_Case / 2, 80);
         break;
     case D_Right:
-        Sprites[locomotive].Affiche(level.T[NumN].DepX * D_Case + D_Case / 2, level.T[NumN].DepY * D_Case + D_Case / 2, 120);
+        Sprites[locomotive].Draw(level.T[NumN].DepX * D_Case + D_Case / 2, level.T[NumN].DepY * D_Case + D_Case / 2, 120);
         break;
     }
 
@@ -296,35 +296,35 @@ void Editor::Affiche() const
     case wagon:
     case pluslong:
     case pluscourt:
-    case vitesse:
-    case vie:
-        Sprites[Option].Affiche(740, 200, 0);
+    case speed:
+    case life:
+        Sprites[Option].Draw(740, 200, 0);
         break;
     case (e_Sprite)(locomotive + D_Top):
-        Sprites[locomotive].Affiche(740, 200, 0);
+        Sprites[locomotive].Draw(740, 200, 0);
         break;
     case (e_Sprite)(locomotive + D_Bottom):
-        Sprites[locomotive].Affiche(740, 200, 40);
+        Sprites[locomotive].Draw(740, 200, 40);
         break;
     case (e_Sprite)(locomotive + D_Left):
-        Sprites[locomotive].Affiche(740, 200, 80);
+        Sprites[locomotive].Draw(740, 200, 80);
         break;
     case (e_Sprite)(locomotive + D_Right):
-        Sprites[locomotive].Affiche(740, 200, 120);
+        Sprites[locomotive].Draw(740, 200, 120);
         break;
     case deco:
-        Sprites[deco].Affiche(740, 200, NumDeco);
+        Sprites[deco].Draw(740, 200, NumDeco);
         break;
     default:
         break;
     }
 
     // Affiche le curseur
     if (Option != deco) {
-        Sprites[curseur].Affiche(m_mouse.Px, m_mouse.Py, 0);
+        Sprites[cursor].Draw(m_mouse.Px, m_mouse.Py, 0);
     }
     else {
-        Sprites[deco].Affiche(m_mouse.Px, m_mouse.Py, NumDeco);
+        Sprites[deco].Draw(m_mouse.Px, m_mouse.Py, NumDeco);
     }
 }
 
@@ -409,10 +409,10 @@ void Editor::PrendTouche(int Tou)
         }
 
         // test le niveau
-        Pref.Niveau = NumN;
+        Pref.Level = NumN;
         m_game.SDLMain();
         m_mouse.Init(nullptr);
-        Affiche();
+        Draw();
         break;
     case 'a':
         Option = rail;
@@ -427,10 +427,10 @@ void Editor::PrendTouche(int Tou)
         Option = pluscourt;
         break;
     case 't':
-        Option = vitesse;
+        Option = speed;
         break;
     case 'y':
-        Option = vie;
+        Option = life;
         break;
     }
 }

src/editor.h

@@ -43,7 +43,7 @@ class Editor
     /*** Fonctions ***/
     /*****************/
     eMenu SDLMain(int NumNiveau); // Boucle principale
-    void Affiche() const; // Charge un tableau
+    void Draw() const; // Charge un tableau
     void PrendTouche(int Touche); // Prend les touches enfoncées
 
 private: