Merge pull request #1 from Gametrock/readme-mods

Updating documentation for readability and adding a Spanish translation to the README.md file

README.md

@@ -1,64 +1,73 @@
-# Slushi Engine! the engine that manages to integrate Windows API functions into a FNF' engine!
+<h1 align="center">Slushi Engine</h1>
+<h2 align="center">The engine that integrates Windows API functions into an FNF' engine!</h2>
 
-![](https://github.com/Slushi-Github/Slushi-Engine/blob/main/docs/readmeImages/SlushiEngineLogo.png)
+<table align="center">
+    <tr>
+        <td><a href="./README.md">English<a></td>
+        <td><a href="./README_ES.md">Español</a></td>
+    </tr>
+</table>
 
-Slushi Engine is made so that you can make your modcharts (with [Modcharting Tools](https://github.com/EdwhakKB/FNF-Modcharting-Tools)) and other [SC Engine](https://github.com/EdwhakKB/SC-SP-ENGINE) utilities while you can also make a kind of modchart but with Windows!
+![Slushi Engine Logo](https://github.com/Slushi-Github/Slushi-Engine/blob/main/docs/readmeImages/SlushiEngineLogo.png)
+
+Slushi Engine is an FNF' engine that allows you to make modcharts with [Modcharting Tools](https://github.com/EdwhakKB/FNF-Modcharting-Tools) and other [SC Engine](https://github.com/EdwhakKB/SC-SP-ENGINE) utilities, while also being able to make a unique kind of modchart that uses Windows functions!
 In addition, SLE takes some inspiration from [NotITG](https://www.noti.tg/) and [HITMANS: THE ANNIHILATE AND DESTROY PROJECT](https://gamebanana.com/mods/453997)
 
 You can do things like this, or even better things!
 
 ![](https://github.com/Slushi-Github/Slushi-Engine/blob/main/docs/readmeImages/VideoDemonstration0.gif)
-[video of this](https://youtu.be/lT-9rTg6f_o?si=8srv0LmbzZ6avGgb)
+[Video of this](https://youtu.be/lT-9rTg6f_o?si=8srv0LmbzZ6avGgb)
 
 The limit is in your mind, and of course, the OS where you run the engine hehe.
 
 Did you like the effects of mods such as No More Innocence, Paranoia from [Mario Madness V2](https://gamebanana.com/mods/359554)? Maelstrom from [Friday Night Troubleshootin'](https://gamebanana.com/mods/320006)?
 That changing the wallpaper, changing the cursor, hiding your taskbar?
 
-Oh, wait, NMI doesn't have public source code right? And neither does Troubleshootin', and they don't make it easy for you to make your songs with such effects, or rather it's impossible to do it natively with the mod engine. 
+Oh, wait, NMI doesn't have public source code right? And neither does Friday Night Troubleshootin', and they don't make it easy for you to make your songs with such effects, or rather it's impossible to do it natively with the mod's engine. 
 
-Well, you are looking at the FNF' engine that will let you get your full potential in relation to certain mechanics of these mods mentioned, through its large amount of Lua functions to make your songs with all this.
+Well, you are looking at the FNF' engine that will let you obtain your full potential in relation to certain mechanics of these mods mentioned, through its large amount of Lua functions to make your songs with all of this.
 
 SLE, is created by me, Andrés, better known on the internet as Slushi, I'm the one who made EVERYTHING, between arts, most of the code and that, but of course, most of the C++ code has been taken from [StackOverflow](https://stackoverflow.com/), or with the help of AIs (like [ChatGPT](https://chatgpt.com/), [Google Gemini](https://gemini.google.com/app), etc...), but also with the help of my friends, like [Glowsoony](https://github.com/glowsoony), or [EdwhakKB](https://github.com/EdwhakKB), like lending me code or helping me in this, that these are the ones who developed SCE, the base of SLE.
 and last but not least, I have also received help from my good friend, [Trock](https://github.com/Gametrock), he is the one who made WinSL a reality!
-without more to say, this IS Slushi Engine. an engine that not only uses FNF as a base, but also the beautiful Slushi, from [Chikn Nuggit](https://twitter.com/chikn_nuggit?t=YohD2quSHtamaiJyzT-FOA&s=09).
+Without more to say, this IS Slushi Engine. an engine that not only uses FNF as a base, but also the beautiful Slushi, from [Chikn Nuggit](https://twitter.com/chikn_nuggit?t=YohD2quSHtamaiJyzT-FOA&s=09).
 
-SLE has a [wiki](https://github.com/Slushi-Github/Slushi-Engine/tree/main/docs/development/SLELuaSpanish) in spanish, of its Lua so you can see all that this engine can do through such a simple language hehe
+SLE has a [wiki](https://github.com/Slushi-Github/Slushi-Engine/tree/main/docs/development/SLELuaSpanish) in Spanish detailing its added Lua functionality, so you can see everything that this engine can do through such a simple language hehe
 
 ### Build Instructions:
 
-[Read This](https://github.com/Slushi-Github/Slushi-Engine/blob/main/docs/development/BuildInstructions.md) to know how to build SLE
+[Read this](https://github.com/Slushi-Github/Slushi-Engine/blob/main/docs/development/BuildInstructions.md) to know how to build SLE
 
 ### Frequently asked questions during the development of the engine:
 
 Is the engine safe?:
-> Yes! SLE may have had suspicious code in the past, like abstracting functions for crashing Windows to modcharts, modifying the Windows registry, but not currently, and never something that leaves permanent or difficult to remove changes,the only change that can stay depending on how your Windows handles it, is to move the desktop icons, they can stay bugged, but it is fixed by restarting windows explorer.
-(if you are working with the engine source, you can remove `SLUSHI_CPP_CODE` from `Project.xml` to remove most of the Windows related functions)
+> Yes! SLE may have had suspicious code in the past, like abstracting functions for crashing Windows to modcharts, modifying the Windows registry, but not currently, and never something that leaves permanent or difficult to remove changes,the only change that can stay depending on how your Windows handles it, is to move the desktop icons, they can stay bugged, but it is fixed by restarting the Windows Explorer.
+(If you are working with the engine source code, removing `SLUSHI_CPP_CODE` from `Project.xml` will eliminate most of the functions related to Windows.)
 
 I don't want the engine to be able to modify things on my system!:
 
 > Ok, you can disable the Windows related effects of the engine in options.
 
 Can SLE be for other systems?:
-> Mm, yes and no, it depends, because SLE is an engine that leverages very strongly the C++ provided for Windows, making that in Linux or Mac, for example, this code is not present, so it does not make much sense to use SLE (In that case I would recommend using SCE directly), but at least if you can compile it on Linux ([Ubuntu 23.10](https://ubuntu.com/)).
+> Mm, yes and no, it depends, as SLE is an engine that is heavily reliant on Windows APIs for its functionality, its functionality may be limited when used in systems running Linux or macOS where these specific APIs aren't available. In such cases, I would recommend using SCE directly, but at least you can compile it on Linux ([Ubuntu 23.10](https://ubuntu.com/)).
 ![](https://github.com/Slushi-Github/Slushi-Engine/blob/main/docs/readmeImages/SLEInUbuntu.png)
 
-On Linux (or MacOS?), is SLE usable through [Wine](https://www.winehq.org/)?:
+On Linux or macOS, is SLE usable through [Wine](https://www.winehq.org/)?:
 > As far as I've tested on my own, yes, but Wine doesn't get along with things like moving the window a lot, at least I've tested on [Ubuntu 22.04](https://ubuntu.com/), I don't know on other distros, Debian based or not.
 
 Can I use SLE for my mod?:
-> Sure! I would love to see SLE as a base for a mod, but of course, SLE, even though it uses SCE as a base, is very modified, making it not always so viable to use it for normal FNF mods, I would recommend you to use it for when you want to make mods that require, what the engine can do, but you are free to experiment, you just have to give me credits where you upload the engine :3
-***Where I would NOT allow you to use SLE, would be for Dave And Bambi mods, sorry, but that's my opinion.***
+> Sure! I would love to see SLE as a base for a mod, but keep in mind that even though it uses SCE as a foundation, SLE has been heavily modified. This might not make it the best choice for typical FNF mods. However, if you're looking to create mods that leverage what the engine can do, feel free to experiment! Just remember to give me credits where you upload the mod.\
+> **Where I would NOT allow SLE to be used is for**
+> - For Dave And Bambi mods
+> - In the creation or distribution of malware or malicious software
 
 ----
-SLE is not made to compete with other engines, like [Psych Engine](https://github.com/ShadowMario/FNF-PsychEngine), [SB Engine](https://github.com/Stefan2008Git/FNF-SB-Engine), [Codename Engine](https://github.com/FNF-CNE-Devs/CodenameEngine) (I wonder why CNE developers decompiled SLE, they had no reason to do that xd?), or other engines that may exist, SLE is made to facilitate things, that would not be easy for anyone, and allowing you, to make modcharts like NotITG or Hitmans AD, with something more than just moving the notes or the window.
+SLE is not made to compete with other engines such as [Psych Engine](https://github.com/ShadowMario/FNF-PsychEngine), [SB Engine](https://github.com/Stefan2008Git/FNF-SB-Engine), [Codename Engine](https://github.com/FNF-CNE-Devs/CodenameEngine) (I wonder why CNE developers decompiled SLE; they had no reason to do that?), or any other existing engines. Instead, SLE is designed to facilitate tasks that might otherwise be challenging and enable you to create modcharts like the ones made in NotITG or Hitman's AD with features beyond simply moving notes or the window.
 
-Soon, you could find ALL the code for specifically C++, as a Haxe library, in Haxelib, for you to use in your projects that are not directly related even to FNF.
-The same with WinSL :3
+In the near future, you can expect to find all C++ code from SLE available as a Haxe library on Haxelib. This will allow you to use it in your projects unrelated to FNF. The same goes for WinSL. :3
 
 ----
 
-Slushi, is neither my OC or a character owned by me. She is from the web series, [Chikn Nuggit](https://twitter.com/chikn_nuggit?t=YohD2quSHtamaiJyzT-FOA&s=09), by Kyra Kupetsky. I do not have direct permission to use Slushi in this engine, all rights to the character go to them.
+Slushi, is neither my original character (OC) nor a character owned by me. She is from the web series, [Chikn Nuggit](https://twitter.com/chikn_nuggit?t=YohD2quSHtamaiJyzT-FOA&s=09), by Kyra Kupetsky. I do not have direct permission to use Slushi in this engine, all rights to the character belong to them.
 
 [SC Engine](https://github.com/EdwhakKB/SC-SP-ENGINE), is only the base of SLE, it is not mine, it is from [EdwhakKB](https://github.com/EdwhakKB), I have his full permission to use SLE on this wonderful engine.
 
@@ -71,7 +80,7 @@ Slushi, is neither my OC or a character owned by me. She is from the web series,
 </details>
 
 ## Features of Slushi Engine:
-- A HUD specifically made for songs using the NotITG mode, to make it look like this game, making it easy to get rid of the normal FNF' look.
+- A HUD specifically made for songs using the NotITG mode, to make it look like the one behind this game, making it easy to get rid of the normal FNF' look.
 - New shaders, available only in SLE
 - An extensive number of new Lua functions for you to experiment with when creating your songs or mods
-- Based on the newest versions of SC Engine
+- Based on the newest versions of SC Engine

README_ES.md

@@ -0,0 +1,85 @@
+<h1 align="center">Slushi Engine</h1>
+<h2 align="center">¡El motor que integra funciones de la API de Windows en un motor de FNF!</h2>
+
+<table align="center">
+    <tr>
+        <td><a href="./README.md">English<a></td>
+        <td><a href="./README_ES.md">Español</a></td>
+    </tr>
+</table>
+
+![Logo de Slushi Engine](https://github.com/Slushi-Github/Slushi-Engine/blob/main/docs/readmeImages/SlushiEngineLogo.png)
+
+Slushi Engine es un motor de FNF que te permite hacer modcharts con [Modcharting Tools](https://github.com/EdwhakKB/FNF-Modcharting-Tools) y otras utilidades del [SC Engine](https://github.com/EdwhakKB/SC-SP-ENGINE), ¡mientras que también te permite hacer un tipo único de modchart que utiliza funciones de Windows!
+Además, SLE toma algo de inspiración de [NotITG](https://www.noti.tg/) y [HITMANS: THE ANNIHILATE AND DESTROY PROJECT](https://gamebanana.com/mods/453997)
+
+¡Puedes hacer cosas como esta, o incluso mejores!
+
+![](https://github.com/Slushi-Github/Slushi-Engine/blob/main/docs/readmeImages/VideoDemonstration0.gif)
+[Video de esto](https://youtu.be/lT-9rTg6f_o?si=8srv0LmbzZ6avGgb)
+
+El único límite está en tu mente, y claro, en el sistema operativo donde ejecutes el motor jeje.
+
+¿Te gustaron los efectos de mods como No More Innocence, Paranoia de [Mario Madness V2](https://gamebanana.com/mods/359554)? ¿Maelstrom de [Friday Night Troubleshootin'](https://gamebanana.com/mods/320006)?
+¿Esas modificaciones al fondo de pantalla, modificaciones al cursor, ocultar la barra de tareas?
+
+Ah, espera, ¿NMI no tiene el código fuente público, verdad? Y tampoco Friday Night Troubleshootin', y no te facilitan hacer tus canciones con esos efectos, o más bien es imposible hacerlo nativamente con el motor del mod.
+
+Bueno, estás mirando el motor de FNF que te permitirá alcanzar tu máximo potencial en relación a ciertas mecánicas de esos mods mencionados, gracias a su gran cantidad de funciones Lua para hacer tus canciones con todo esto.
+
+SLE, lo creé yo, Andrés, mejor conocido en internet como Slushi, yo soy quien hizo TODO, entre el arte, la mayoría del código y eso, pero claro, la mayor parte del código en C++ ha sido tomado de [StackOverflow](https://stackoverflow.com/), o con la ayuda de IAs (como [ChatGPT](https://chatgpt.com/), [Google Gemini](https://gemini.google.com/app), etc...), pero también con la ayuda de mis amigos, como [Glowsoony](https://github.com/glowsoony), o [EdwhakKB](https://github.com/EdwhakKB), prestándome código o ayudándome en esto, ya que son quienes desarrollaron SCE, la base de SLE.
+Y por último, pero no menos importante, también he recibido ayuda de mi buen amigo [Trock](https://github.com/Gametrock), ¡él es quien hizo realidad WinSL!
+Sin más que decir, esto ES Slushi Engine, un motor que no solo usa FNF como base, sino también al hermoso Slushi, de [Chikn Nuggit](https://twitter.com/chikn_nuggit?t=YohD2quSHtamaiJyzT-FOA&s=09).
+
+SLE tiene una [wiki](https://github.com/Slushi-Github/Slushi-Engine/tree/main/docs/development/SLELuaSpanish) en español detallando su funcionalidad añadida en Lua, para que puedas ver todo lo que este motor puede hacer a través de un lenguaje tan sencillo jeje.
+
+### Instrucciones de compilación:
+
+[Lee esto](https://github.com/Slushi-Github/Slushi-Engine/blob/main/docs/development/BuildInstructions.md) para saber cómo compilar SLE.
+
+### Preguntas frecuentes durante el desarrollo del motor:
+
+¿Es seguro el motor?:
+> ¡Sí! SLE pudo haber tenido código sospechoso en el pasado, como abstracciones de funciones para hacer crashear Windows en modcharts, modificar el registro de Windows, pero ya no lo tiene actualmente, y nunca algo que deje cambios permanentes o difíciles de eliminar. El único cambio que puede permanecer, dependiendo de cómo maneje Windows esto, es mover los íconos del escritorio, que pueden quedar desordenados, pero se arregla reiniciando el Explorador de Windows.
+(Si estás trabajando con el código fuente del motor, eliminando `SLUSHI_CPP_CODE` de `Project.xml` eliminarás la mayoría de las funciones relacionadas con Windows.)
+
+¡No quiero que el motor modifique cosas en mi sistema!:
+> Ok, puedes desactivar los efectos relacionados con Windows en las opciones.
+
+¿SLE puede ser usado en otros sistemas?:
+> Mm, sí y no, depende, ya que SLE es un motor que depende mucho de las APIs de Windows para su funcionamiento, su funcionalidad puede estar limitada cuando se usa en sistemas que ejecutan Linux o macOS, donde estas APIs específicas no están disponibles. En tales casos, recomendaría usar SCE directamente, pero al menos puedes compilarlo en Linux ([Ubuntu 23.10](https://ubuntu.com/)).
+![](https://github.com/Slushi-Github/Slushi-Engine/blob/main/docs/readmeImages/SLEInUbuntu.png)
+
+¿En Linux o macOS, SLE es usable a través de [Wine](https://www.winehq.org)?:
+> Según lo que he probado por mi cuenta, sí, pero Wine no se lleva bien con cosas como mover mucho la ventana, al menos lo he probado en [Ubuntu 22.04](https://ubuntu.com/), no sé en otras distros, basadas en Debian o no.
+
+¿Puedo usar SLE para mi mod?:
+> ¡Por supuesto! Me encantaría ver SLE como base para un mod, pero ten en cuenta que aunque usa SCE como base, SLE ha sido muy modificado. Esto puede que no lo haga la mejor opción para mods típicos de FNF. Sin embargo, si buscas crear mods que aprovechen lo que el motor puede hacer, ¡siéntete libre de experimentar! Solo recuerda darme créditos donde subas el mod.\
+> **Dónde NO permitiría que se use SLE es para**
+> - Mods de Dave And Bambi
+> - En la creación o distribución de malware o software malicioso
+
+----
+SLE no está hecho para competir con otros motores como [Psych Engine](https://github.com/ShadowMario/FNF-PsychEngine), [SB Engine](https://github.com/Stefan2008Git/FNF-SB-Engine), [Codename Engine](https://github.com/FNF-CNE-Devs/CodenameEngine) (¿Me pregunto por qué los desarrolladores de CNE descompilaron SLE? No tenían razón para hacerlo), u otros motores existentes. En cambio, SLE está diseñado para facilitar tareas que de otro modo serían desafiantes y permitirte crear modcharts como los hechos en NotITG o Hitman's AD, con características más allá de simplemente mover las notas o la ventana.
+
+En un futuro cercano, puedes esperar encontrar todo el código C++ de SLE disponible como una biblioteca de Haxe en Haxelib. Esto te permitirá usarlo en tus proyectos no relacionados con FNF. Lo mismo ocurre con WinSL. :3
+
+----
+
+Slushi, no es ni mi personaje original (OC) ni un personaje que me pertenezca. Ella es de la serie web [Chikn Nuggit](https://twitter.com/chikn_nuggit?t=YohD2quSHtamaiJyzT-FOA&s=09), de Kyra Kupetsky. No tengo permiso directo para usar a Slushi en este motor, todos los derechos sobre el personaje pertenecen a ellos.
+
+[SC Engine](https://github.com/EdwhakKB/SC-SP-ENGINE), es solo la base de SLE, no es mío, es de [EdwhakKB](https://github.com/EdwhakKB), tengo su permiso completo para usar SLE en este maravilloso motor.
+
+----
+
+<details>
+<summary>...</summary>
+"Gracias [...] por siempre apoyarme en este proyecto desde que se me ocurrió la idea de iniciarlo, y también a ti [...], incluso si ya no estás en este mundo." 
+- Andrés.
+</details>
+
+## Características del Slushi Engine:
+- Un HUD hecho específicamente para canciones usando el modo NotITG, para que se vea como el de ese juego, facilitando deshacerte del look normal de FNF.
+- Nuevos shaders, disponibles solo en SLE.
+- Un extenso número de nuevas funciones en Lua para que experimentes al crear tus canciones o mods.
+- Basado en las versiones más recientes de SC Engine.