Skip to content

Lang/rename to english - Full translation of comments and code. #98

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
0yech wants to merge 20 commits into
base: main
Choose a base branch
from
Open

Lang/rename to english - Full translation of comments and code. #98

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
d6cca8a
lang: Translated comments and code for Audio in English
0yech Mar 23, 2026
3657d3b
lang: Translated editor to English
0yech Mar 24, 2026
0d7ffa4
lang: Translation, Progress on game.cc/game.h, impacts many files
0yech Mar 24, 2026
e9d29b3
lang: Translated level.cc, level.h
0yech Mar 24, 2026
adf1beb
lang: Translated loco.cc, loco.h
0yech Mar 24, 2026
88b195f
lang: Translated menu.cc, menu.h
0yech Mar 24, 2026
d7fc753
typos
0yech Mar 24, 2026
873e141
lang: Translated menu.h
0yech Mar 24, 2026
16e0e5c
lang: Translated mouse.cc, mouse.h
0yech Mar 24, 2026
6cd2996
lang: Added comments to preferences.h
0yech Mar 24, 2026
090d75f
lang: Translated screen.cc, screen.h
0yech Mar 24, 2026
3d19581
lang: Translated sprite.cc, sprite.h, utils.cc
0yech Mar 24, 2026
38eace6
lang: Revert game1.xm back to jeu1.xm
0yech Mar 24, 2026
da2e27e
lang: Translations done, requires bugfix
0yech Mar 24, 2026
ce45ee8
fix: Locomotive not appearing after first translation
0yech Mar 24, 2026
da9950d
fix: bugs from translating code
0yech Mar 24, 2026
2773cc0
lang: added last missing translations
0yech Mar 24, 2026
58f5962
fix: removed renamed file
0yech Mar 24, 2026
fbf85ea
fix: clang-format compliance
0yech Mar 24, 2026
4d66861
fix: clang-tidy compliance
0yech Mar 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
0 Sounds/wagon.wav → Sounds/car.wav
View file
Open in desktop
File renamed without changes.
0 Sounds/clic.wav → Sounds/click.wav
View file
Open in desktop
File renamed without changes.
0 Sounds/etire.wav → Sounds/expand.wav
View file
Open in desktop
File renamed without changes.
0 Sounds/reduit.wav → Sounds/shrink.wav
View file
Open in desktop
File renamed without changes.
82 changes: 41 additions & 41 deletions src/audio.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,29 +30,29 @@
#include "utils.h"
#include "preference.h"

/*** Variable globales ***/
/*** Global variables ***/
Copy link
Owner

@petitlapin petitlapin Mar 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is the kind of comment I think is useless: we know they are global variables, constructors or destructors, no need to tell it, it's obvious for anyone reading the file

/*************************/
extern sNewPreference Pref;
extern int currentTime;

/*** Constructeur et Destructeur ***/
/***********************************/
/*** Constructors and destructors ***/
/************************************/
Audio::~Audio()
{
if (N) {
Mix_HaltChannel(-1);
for (int i = 0; i < N; i++) {
if (Son[i]) {
Mix_FreeChunk(Son[i]);
if (Sound[i]) {
Mix_FreeChunk(Sound[i]);
}
}
delete[] Son;
delete[] Sound;
}
Mix_CloseAudio();
}

/*** Initialise l'Audio ***/
/**************************/
/*** Initializes audio ***/
Copy link
Owner

@petitlapin petitlapin Mar 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this one also is useless for me, the method name should be self-explanatory. So either Init is good enough to know we are initializing the audio, or we should rename it InitializeAudio and in both cases, no need of the comment

/*************************/
bool Audio::Init()
{
char PathFile[512];
Expand All @@ -62,46 +62,46 @@ bool Audio::Init()
return false;
}

/*** Allocation de la mémoire ***/
N = sFin;
Son = new Mix_Chunk *[sFin];
/*** Memory allocation ***/
N = sSize;
Sound = new Mix_Chunk *[sSize];

/*** Chargement des sons ***/
strcpy(PathFile, "Sounds/clic.wav");
/*** Loading sound effects ***/
strcpy(PathFile, "Sounds/click.wav");
Utils::GetPath(PathFile);
Son[sClic] = Mix_LoadWAV(PathFile);
Sound[sClick] = Mix_LoadWAV(PathFile);

strcpy(PathFile, "Sounds/speed.wav");
Utils::GetPath(PathFile);
Son[sSpeed] = Mix_LoadWAV(PathFile);
Sound[sSpeed] = Mix_LoadWAV(PathFile);

strcpy(PathFile, "Sounds/crash.wav");
Utils::GetPath(PathFile);
Son[sCrash] = Mix_LoadWAV(PathFile);
Sound[sCrash] = Mix_LoadWAV(PathFile);

strcpy(PathFile, "Sounds/end.wav");
Utils::GetPath(PathFile);
Son[sEnd] = Mix_LoadWAV(PathFile);
Sound[sEnd] = Mix_LoadWAV(PathFile);

strcpy(PathFile, "Sounds/lose.wav");
Utils::GetPath(PathFile);
Son[sLose] = Mix_LoadWAV(PathFile);
Sound[sLose] = Mix_LoadWAV(PathFile);

strcpy(PathFile, "Sounds/etire.wav");
strcpy(PathFile, "Sounds/expand.wav");
Utils::GetPath(PathFile);
Son[sEtire] = Mix_LoadWAV(PathFile);
Sound[sExpand] = Mix_LoadWAV(PathFile);

strcpy(PathFile, "Sounds/wagon.wav");
strcpy(PathFile, "Sounds/car.wav");
Utils::GetPath(PathFile);
Son[sWagon] = Mix_LoadWAV(PathFile);
Sound[sCar] = Mix_LoadWAV(PathFile);

strcpy(PathFile, "Sounds/reduit.wav");
strcpy(PathFile, "Sounds/shrink.wav");
Utils::GetPath(PathFile);
Son[sReduit] = Mix_LoadWAV(PathFile);
Sound[sShrink] = Mix_LoadWAV(PathFile);

strcpy(PathFile, "Sounds/live.wav");
Utils::GetPath(PathFile);
Son[sLive] = Mix_LoadWAV(PathFile);
Sound[sLive] = Mix_LoadWAV(PathFile);

strcpy(PathFile, "Sounds/menu.mod");
Utils::GetPath(PathFile);
Expand All @@ -110,8 +110,8 @@ bool Audio::Init()
return true;
}

/*** Charge une music 0=menu 1,2,3,4 = game ***/
/**********************************************/
/*** Loads a music track, 0 = menu music 1,2,3,4=game music tracks ***/
Copy link
Owner

@petitlapin petitlapin Mar 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this one is a valid one, the behaviour cannot be explained just with the name, it makes sense to have this comment

/*********************************************************************/
void Audio::LoadMusic(int Num)
{
char Provi[512] = "Sounds/jeu1.xm";
Expand All @@ -124,12 +124,12 @@ void Audio::LoadMusic(int Num)

if (Music) {
PauseMusic(true);
Mix_HaltMusic(); // Arrete la music
Mix_HaltMusic(); // Stops the music
Mix_FreeMusic(Music);
Music = nullptr;
}

if (Num == 0) { // Si music du menu
if (Num == 0) { // if menu music
strcpy(Provi, "Sounds/menu.mod");
Utils::GetPath(Provi);
Music = Mix_LoadMUS(Provi);
Expand All @@ -142,8 +142,8 @@ void Audio::LoadMusic(int Num)
PlayMusic();
}

/*** Passe à la music de jeu suivante ***/
/****************************************/
/*** Swaps to next game track ***/
/********************************/
void Audio::NextMusic()
{
NMus++;
Expand All @@ -153,26 +153,26 @@ void Audio::NextMusic()
LoadMusic(NMus);
}

/*** Fait la lecture d'un son ***/
/********************************/
void Audio::Play(eSon So)
/*** Plays a sound effect ***/
/****************************/
void Audio::Play(eSound index)
{
if (!N) {
return;
}

if (So == sClic) {
if (index == sClick) {
if (currentTime - MemorizedTime <= 120) {
return;
}
MemorizedTime = currentTime;
}

Mix_PlayChannel(-1, Son[So], 0);
Mix_PlayChannel(-1, Sound[index], 0);
}

/*** Joue la music ***/
/*********************/
/*** Plays the music ***/
/***********************/
void Audio::PlayMusic() const
{
if (Music && N) {
Expand All @@ -181,21 +181,21 @@ void Audio::PlayMusic() const
}
}

void Audio::PauseMusic(bool Et) const
void Audio::PauseMusic(bool IsMusicPlaying) const
{
if (!N) {
return;
}

if (Et) {
if (IsMusicPlaying) {
Mix_PauseMusic();
}
else {
Mix_ResumeMusic();
}
}

/*** Valide les Volumes ***/
/*** Handles sound volumes ***/
/**************************/
void Audio::DoVolume() const
{
Expand Down
46 changes: 23 additions & 23 deletions src/audio.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,48 +26,48 @@

#include <SDL2/SDL_mixer.h>

/*** Enumération des sons ***/
/****************************/
enum eSon {
sClic = 0,
/*** Sound effects enum ***/
/**************************/
enum eSound {
sClick = 0,
sSpeed,
sCrash,
sEnd,
sLose,
sEtire,
sWagon,
sReduit,
sExpand,
sCar,
sShrink,
sLive,
sFin
sSize
};

/*** Définition de la classe Audio ***/
/*************************************/
/*** Audio Class definition ***/
/******************************/
class Audio
{
public:
Audio() = default;
~Audio();

/*** Fonctions ***/
bool Init(); // Initialise et charge les fichiers audio
void LoadMusic(int Num); // Charge une music, 0 = music du menu 1,2,3,4=Jeu
void NextMusic(); // Passe à la music suivante
/*** Functions ***/
bool Init(); // Initializes and loads audio files
void LoadMusic(int Num); // Loads a music track, 0 = menu music 1,2,3,4=game music tracks
void NextMusic(); // Swaps to next game track

void Play(eSon); // Joue un son
void PlayMusic() const; // Joue la music
void Play(eSound); // Plays a sound effect
void PlayMusic() const; // Plays the music

void PauseMusic(bool Etat) const; // Met ou no la music en pause
void PauseMusic(bool IsMusicPlaying) const; // Pauses/Resumes music

void DoVolume() const; // Valide les volumes audio
Mix_Music *Music { nullptr }; // Pointe sur les musics
void DoVolume() const; // Handles sound volumes
Mix_Music *Music { nullptr }; // Pointer to music tracks

private:
/*** Variables ***/
int N { 0 }; // Nombre d'échantillon audio
int NMus { 0 }; // Numéro de la music en cours
int MemorizedTime { 0 }; // Mémorise l'horloge pour les clics
Mix_Chunk **Son { nullptr }; // Pointe sur les sons
int N { 0 }; // Number/Amount of sound effects
int NMus { 0 }; // Number of the current music
int MemorizedTime { 0 }; // Memorizes time for clicks
Mix_Chunk **Sound { nullptr }; // Pointer to sound effects
};

#endif
Loading
Loading