Relicensing under GPL V3 (#16)

* added CONTRIBUTING.md + update README.md

* Relicensing under GPL V3

* Add license to typescript files

* Add license to glsl files

* added license to scss

* added license to notebooks

CONTRIBUTING.md

@@ -0,0 +1,64 @@
+# Contributing to CosmosJourneyer
+
+CosmosJourneyer is an open source project and contributions are welcome! There is too much to do for one person alone. If you want to contribute, please read the following guidelines first.
+
+## How to contribute
+
+### Reporting bugs
+
+Finding bugs and reporting them is key to make the project better. If you find a bug, please open an issue on the [issue tracker](https://github.com/BarthPaleologue/CosmosJourneyer/issues/new?assignees=&labels=&projects=&template=bug_report.md&title=)
+
+### Suggesting features
+
+If you have an idea for a new feature, please open an issue on the [issue tracker](https://github.com/BarthPaleologue/CosmosJourneyer/issues/new?assignees=&labels=&projects=&template=feature_request.md&title=)
+
+### Pull requests
+
+Pull requests are welcome! If you want to contribute code, please follow these steps:
+
+1. Fork the repository
+2. Create a new branch
+3. Make your changes
+4. Commit your changes
+5. Push your changes
+6. Open a pull request
+
+You can open a draft pull request if you want to get feedback on your changes before they are ready to be merged.
+
+Pull request are tested against the linter and the unit tests, make sure you run them before opening a pull request.
+
+Code that does not pass the linter or the unit tests will not be merged.
+
+## Contribution ideas
+
+There is still plenty to do on CosmosJourneyer. Here are some ideas of contributions you can make (with stars indicating the difficulty of the task):
+
+### Visuals
+
+- Improve the visuals of Neutron Stars to make the cone of the matter jets less visible (⭐⭐)
+- Improve the visuals of Gas Giants to make them look better from closer (⭐⭐)
+- Improve the visuals of the ocean using a separate mesh and FFT for wave generation (⭐⭐⭐)
+- Experiment with volumetric clouds (⭐⭐⭐)
+
+### On-foot exploration
+
+- Add new character animations (using Mixamo for example) (⭐)
+- Make the character animation system more scalable (⭐⭐⭐)
+- Add conditions to asset scattering to avoid grass in desert and at the bottom of the ocean (⭐⭐)
+
+### Space gameplay
+
+- Add a cockpit view for spaceships (⭐⭐⭐)
+- Add new spaceships and space stations (⭐⭐⭐)
+- Add lasers to spaceships (⭐⭐)
+- Add trade missions at space stations (⭐⭐⭐)
+
+### Optimization
+
+- Optimize the volumetric atmosphere rendering (⭐⭐⭐)
+- Optimize the lens flare rendering (⭐⭐)
+
+### Miscellaneous
+
+- Improve WebGPU support (⭐⭐⭐)
+- Improve the documentation (⭐)

README.md

@@ -5,22 +5,52 @@
 [![Jest Coverage](https://github.com/BarthPaleologue/CosmosJourneyer/actions/workflows/tests.yml/badge.svg)](https://github.com/BarthPaleologue/CosmosJourneyer/actions/workflows/tests.yml)
 [![License](https://img.shields.io/github/license/BarthPaleologue/planetEngine)](./LICENSE.md)
 
-CosmosJourneyer is an open-source procedural universe running in the browser that makes space exploration accessible for everyone.
+CosmosJourneyer is the procedural universe running inside a web page that makes space exploration accessible for everyone.
 
 The main website of the project is online at https://cosmosjourneyer.com/
 
 The main deployment of the procedural universe can be accessed https://barthpaleologue.github.io/CosmosJourneyer/
 
+## Documentation
+
 The documentation is online at https://barthpaleologue.github.io/CosmosJourneyer/docs/
 
+To build it locally, run `npm run docs` and then `npm run serve:docs` to serve it at `localhost:8081`.
+
+## Contributing
+
+Contributions are welcome! There is too much to do for one person alone. 
+
+If you want to contribute, you will find guidelines and ideas [here](./CONTRIBUTING.md).
+
+## Sponsor
+
+The project has a ko-fi page at https://ko-fi.com/cosmosjourneyer if you feel like sponsoring the project!
+
+## Features
+
+Every telluric planet and moon has a surface that can be explored by the player using a spaceship, or by foot!
+
 ![From Space](./coverImages/space.png)
 
+CosmosJourneyer allows to travel from one celestial body to another without any loading screen, giving the player a seamless experience while exploring.
+
 ![A little bit closer](./coverImages/moon.png)
 
+Planet surfaces are filled with procedural vegetation and rocks and butterflies to make them feel more alive.
+
 ![On the surface](./coverImages/ground.png)
 
+CosmosJourneyer generates a virtually infinite amount of star systems that all have a star, often planets, and sometimes moons.
+
 ![Star map](./coverImages/starmap.png)
 
+## Contributors
+
+Thank you to all the people who have contributed to CosmosJourneyer!
+
+![Contributors](https://contrib.rocks/image?repo=BarthPaleologue/CosmosJourneyer)
+
 ## Special Thanks
 
 - Bilal Molli for his fearless refactoring of the messy code base in its early days

research/corpsNoir/corpsNoir.ipynb

@@ -7,6 +7,28 @@
     "<h1>Rayonnement de Corps Noir</h1>"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "This file is part of CosmosJourneyer\n",
+    "\n",
+    "Copyright (C) 2024 Barthélemy Paléologue <barth.paleologue@cosmosjourneyer.com>\n",
+    "\n",
+    "This program is free software: you can redistribute it and/or modify\n",
+    "it under the terms of the GNU General Public License as published by\n",
+    "the Free Software Foundation, either version 3 of the License, or\n",
+    "(at your option) any later version.\n",
+    "\n",
+    "This program is distributed in the hope that it will be useful,\n",
+    "but WITHOUT ANY WARRANTY; without even the implied warranty of\n",
+    "MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\n",
+    "GNU General Public License for more details.\n",
+    "\n",
+    "You should have received a copy of the GNU General Public License\n",
+    "along with this program.  If not, see <https://www.gnu.org/licenses/>.\n"
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": 2,

research/densityAtmophere/main.ipynb

@@ -1,5 +1,27 @@
 {
  "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "This file is part of CosmosJourneyer\n",
+    "\n",
+    "Copyright (C) 2024 Barthélemy Paléologue <barth.paleologue@cosmosjourneyer.com>\n",
+    "\n",
+    "This program is free software: you can redistribute it and/or modify\n",
+    "it under the terms of the GNU General Public License as published by\n",
+    "the Free Software Foundation, either version 3 of the License, or\n",
+    "(at your option) any later version.\n",
+    "\n",
+    "This program is distributed in the hope that it will be useful,\n",
+    "but WITHOUT ANY WARRANTY; without even the implied warranty of\n",
+    "MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\n",
+    "GNU General Public License for more details.\n",
+    "\n",
+    "You should have received a copy of the GNU General Public License\n",
+    "along with this program.  If not, see <https://www.gnu.org/licenses/>."
+   ]
+  },
   {
    "attachments": {},
    "cell_type": "markdown",

research/expGradient/expGradient.ipynb

@@ -7,6 +7,28 @@
     "<h1>Calcul du gradient de l'exponentielle d'une fonction différentiable de R³ dans R</h1>"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "This file is part of CosmosJourneyer\n",
+    "\n",
+    "Copyright (C) 2024 Barthélemy Paléologue <barth.paleologue@cosmosjourneyer.com>\n",
+    "\n",
+    "This program is free software: you can redistribute it and/or modify\n",
+    "it under the terms of the GNU General Public License as published by\n",
+    "the Free Software Foundation, either version 3 of the License, or\n",
+    "(at your option) any later version.\n",
+    "\n",
+    "This program is distributed in the hope that it will be useful,\n",
+    "but WITHOUT ANY WARRANTY; without even the implied warranty of\n",
+    "MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\n",
+    "GNU General Public License for more details.\n",
+    "\n",
+    "You should have received a copy of the GNU General Public License\n",
+    "along with this program.  If not, see <https://www.gnu.org/licenses/>."
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": 1,

research/periodicClouds/research.ipynb

@@ -1,5 +1,27 @@
 {
  "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "This file is part of CosmosJourneyer\n",
+    "\n",
+    "Copyright (C) 2024 Barthélemy Paléologue <barth.paleologue@cosmosjourneyer.com>\n",
+    "\n",
+    "This program is free software: you can redistribute it and/or modify\n",
+    "it under the terms of the GNU General Public License as published by\n",
+    "the Free Software Foundation, either version 3 of the License, or\n",
+    "(at your option) any later version.\n",
+    "\n",
+    "This program is distributed in the hope that it will be useful,\n",
+    "but WITHOUT ANY WARRANTY; without even the implied warranty of\n",
+    "MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\n",
+    "GNU General Public License for more details.\n",
+    "\n",
+    "You should have received a copy of the GNU General Public License\n",
+    "along with this program.  If not, see <https://www.gnu.org/licenses/>."
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": 12,

research/plafondPlancherSimplex/research.ipynb

@@ -7,6 +7,28 @@
     "<h1>Plafonnage et Seuillage d'une fonction de R³ dans R différentiable par minimum et maximum lissé</h1>"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "This file is part of CosmosJourneyer\n",
+    "\n",
+    "Copyright (C) 2024 Barthélemy Paléologue <barth.paleologue@cosmosjourneyer.com>\n",
+    "\n",
+    "This program is free software: you can redistribute it and/or modify\n",
+    "it under the terms of the GNU General Public License as published by\n",
+    "the Free Software Foundation, either version 3 of the License, or\n",
+    "(at your option) any later version.\n",
+    "\n",
+    "This program is distributed in the hope that it will be useful,\n",
+    "but WITHOUT ANY WARRANTY; without even the implied warranty of\n",
+    "MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\n",
+    "GNU General Public License for more details.\n",
+    "\n",
+    "You should have received a copy of the GNU General Public License\n",
+    "along with this program.  If not, see <https://www.gnu.org/licenses/>."
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": 4,

research/powGradient/powGradient.ipynb

@@ -7,6 +7,28 @@
     "<h1>Calcul du gradient de la puissance alpha d'une fonction différentiable de R³ dans R</h1>"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "This file is part of CosmosJourneyer\n",
+    "\n",
+    "Copyright (C) 2024 Barthélemy Paléologue <barth.paleologue@cosmosjourneyer.com>\n",
+    "\n",
+    "This program is free software: you can redistribute it and/or modify\n",
+    "it under the terms of the GNU General Public License as published by\n",
+    "the Free Software Foundation, either version 3 of the License, or\n",
+    "(at your option) any later version.\n",
+    "\n",
+    "This program is distributed in the hope that it will be useful,\n",
+    "but WITHOUT ANY WARRANTY; without even the implied warranty of\n",
+    "MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\n",
+    "GNU General Public License for more details.\n",
+    "\n",
+    "You should have received a copy of the GNU General Public License\n",
+    "along with this program.  If not, see <https://www.gnu.org/licenses/>."
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": 1,

research/produitGradient/produit.ipynb

@@ -7,6 +7,28 @@
     "<h1>Calcul du gradient du produit de deux fonctions différentiables de R³ dans R</h1>"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "This file is part of CosmosJourneyer\n",
+    "\n",
+    "Copyright (C) 2024 Barthélemy Paléologue <barth.paleologue@cosmosjourneyer.com>\n",
+    "\n",
+    "This program is free software: you can redistribute it and/or modify\n",
+    "it under the terms of the GNU General Public License as published by\n",
+    "the Free Software Foundation, either version 3 of the License, or\n",
+    "(at your option) any later version.\n",
+    "\n",
+    "This program is distributed in the hope that it will be useful,\n",
+    "but WITHOUT ANY WARRANTY; without even the implied warranty of\n",
+    "MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\n",
+    "GNU General Public License for more details.\n",
+    "\n",
+    "You should have received a copy of the GNU General Public License\n",
+    "along with this program.  If not, see <https://www.gnu.org/licenses/>."
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": 1,

research/smoothMinOfSimplex/research.ipynb

@@ -7,6 +7,28 @@
     "<h1>Calcul du gradient du minimum et maximum lissé entre deux fonctions de R³->R différentiables</h1>"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "This file is part of CosmosJourneyer\n",
+    "\n",
+    "Copyright (C) 2024 Barthélemy Paléologue <barth.paleologue@cosmosjourneyer.com>\n",
+    "\n",
+    "This program is free software: you can redistribute it and/or modify\n",
+    "it under the terms of the GNU General Public License as published by\n",
+    "the Free Software Foundation, either version 3 of the License, or\n",
+    "(at your option) any later version.\n",
+    "\n",
+    "This program is distributed in the hope that it will be useful,\n",
+    "but WITHOUT ANY WARRANTY; without even the implied warranty of\n",
+    "MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\n",
+    "GNU General Public License for more details.\n",
+    "\n",
+    "You should have received a copy of the GNU General Public License\n",
+    "along with this program.  If not, see <https://www.gnu.org/licenses/>."
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": 1,

research/tanhSharpen/expGradient.ipynb

@@ -7,6 +7,28 @@
     "<h1>Calcul du gradient de la composition d'un fonction de R avec la tangente hyperbolique d'interpolation</h1>"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "This file is part of CosmosJourneyer\n",
+    "\n",
+    "Copyright (C) 2024 Barthélemy Paléologue <barth.paleologue@cosmosjourneyer.com>\n",
+    "\n",
+    "This program is free software: you can redistribute it and/or modify\n",
+    "it under the terms of the GNU General Public License as published by\n",
+    "the Free Software Foundation, either version 3 of the License, or\n",
+    "(at your option) any later version.\n",
+    "\n",
+    "This program is distributed in the hope that it will be useful,\n",
+    "but WITHOUT ANY WARRANTY; without even the implied warranty of\n",
+    "MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\n",
+    "GNU General Public License for more details.\n",
+    "\n",
+    "You should have received a copy of the GNU General Public License\n",
+    "along with this program.  If not, see <https://www.gnu.org/licenses/>."
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": 6,