Skip to content

Latest commit

 

History

History
281 lines (206 loc) · 11.4 KB

README.md

File metadata and controls

281 lines (206 loc) · 11.4 KB
Raw

Project eMush

pipeline coverage discord localization

eMush is an open source remake of Mush: the greatest space opera epic of Humanity, directly in your browser!

eMush Api

A REST Api developed using Symfony 6.2 that manages the eMush game.

Please read API.md for details on the API architecture.

eMush App

A front-end developed using VueJs 3.

Please read APP.md for details on the APP architecture.

Getting Started

Gitpod : your development environment in the cloud

If you don't want to go through the installation process, you can use the project's Gitpod workspace:

Open in Gitpod

This will create a new workspace in the cloud with all the dependencies installed and the project ready to run with your prefered IDE. You need a Gitpod account to use this feature.

Installing with Docker

Windows Users:

Windows users first need to install WSL2 and Docker Desktop.

Docker Desktop for Windows can be downloaded here.

WSL2 should be installed by default on recent Windows 10+ versions. Try running wsl --set-default-version 2 in a Powershell terminal. If it doesn't work, follow the instructions here.

Install Debian with WSL2 : wsl --install -d Debian

Then launch it : wsl -d Debian

After configuring your Debian account, you can install the project following the instructions below.

Install build tools and Docker

  • Install build tools and Git :
sudo -s
apt update -y
apt install build-essential curl git -y
  • Install Docker and Docker Compose in command line :
install -m 0755 -d /etc/apt/keyrings
curl -fsSL https://download.docker.com/linux/debian/gpg -o /etc/apt/keyrings/docker.asc
chmod a+r /etc/apt/keyrings/docker.asc
echo "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.asc] https://download.docker.com/linux/debian \
  $(. /etc/os-release && echo "$VERSION_CODENAME") stable" | \
  sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
apt update -y
apt install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin -y
exit # Quit root mode
cd ~ # Go back to your home directory

Then, add your user to the Docker group :

sudo groupadd docker
sudo usermod -aG docker $USER
newgrp docker

Run docker run hello-world to check if Docker is correctly installed. If not :

  • try to run it in a new terminal ;
  • log off and log in again ;
  • restart your computer and try again.

Install the project

  • If not done yet, generate a SSH key and add it to your GitLab profile :

    • Generate the key : ssh-keygen -t rsa -b 2048 -C "SSH Key for eMush repository (https://gitlab.com/eternaltwin/mush/mush)"
    • Display the key : cat ~/.ssh/id_rsa.pub
    • Copy the key and add it to your GitLab profile here : https://gitlab.com/-/user_settings/ssh_keys/

  • Clone the repository and move to it : git clone [email protected]:eternaltwin/mush/mush.git && cd mush

  • Build the project : make install

That's it!

If everything went well you should be able to access:

Use the following credentials to login (all users - named by eMush characters - have the same password):

username : andie
password : 1234567891

You should land in a fully working Daedalus!

Installing without Docker

TODO : write a Bash and a Powershell script because I hate typing multiple commands to install a project

nvm install latest
nvm use latest
npm install -g yarn

activate extension=pdo_pgsql
activate extension=intl

openssl genpkey -out config/jwt/private.pem -aes256 -algorithm rsa -pkeyopt rsa_keygen_bits:4096
openssl pkey -in config/jwt/private.pem -out config/jwt/public.pem -pubout
chmod go+r config/jwt/private.pem

  • Use mush as passphrase or update the .env with your passphrase

  • In folder Api/

    • cp .env.dist .env
    • Replace all instances of mush_eternaltwin by localhost in your .env
    • Install and launch eMush back-end:
composer update
php bin/console mush:migrate --dev
php -S localhost:8080 -t public

  • In folder App/

    • cp .env.dist .env
    • Modify .env VITE_APP_URL value to http://localhost:5173
    • Install and launch eMush front-end:
yarn install
yarn serve

  • In folder EternalTwin/

    • cp eternaltwin.toml eternaltwin.local.toml
    • Modify eternaltwin.local.toml uri value to http://localhost:5173
    • Install and launch Eternaltwin server:
yarn install
yarn etwin db create
yarn etwin start

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Endpoints

A swagger is available that list all the available endpoints and their specifications : Swagger

To authenticate, at the moment, use the login endpoint and set the access_token returned in the swagger header to use the other endpoints

Gitlab

This project use gitlab ci to check the merge requests

Gitlab docker php images

This image is used for the php environment validation

The dockerfile: Dockerfile

Update the container in gitlab

docker login registry.gitlab.com -u YOUR_USERNAME -p ACCESSS_TOKEN
docker build -t registry.gitlab.com/eternaltwin/mush/mush/api ./docker/gitlab/Php/
docker push registry.gitlab.com/eternaltwin/mush/mush/api

Username can be found at: https://gitlab.com/-/profile under Full Name

Access Token can be created at: https://gitlab.com/-/profile/personal_access_tokens (you can also connect with password by using docker login registry.gitlab.com -u YOUR_USERNAME then entering your password)

Troubleshooting

Eternaltwin login / website not working (Ports are not available: listen tcp 0.0.0.0:50320: bind : An attempt was made to access a socket in a way forbidden by its access permissions).

Open Powershell as an administrator and run the following commands :

netsh int ipv4 set dynamic tcp start=60536 num=5000
netsh int ipv6 set dynamic tcp start=60536 num=5000

Restart your computer, then try to run make docker-start again.

Use different ports

To use different port modify the docker/docker-compose.dev.yml file

Changing front port:

in docker/docker-compose.dev.yml Change line 55: - "80:5173" by - "new_port:5173" where new_port is the desired port Change the App/.env VITE_APP_URL=http://localhost by VITE_APP_URL=http://localhost:new_port Run make docker-start (make gitpod-start on Gitpod) so that the changes are taken into account

Changing back port:

  • in docker/docker-compose.dev.yml: Change line 8: - "8080:80" by - "new_port:80" where new_port is the desired port

  • Change the App/.env VITE_APP_API_URL=http://localhost:8080/api/v1/ VITE_APP_OAUTH_URL=http://localhost:8080/oauth by VITE_APP_API_URL=http://localhost:new_port/api/v1/ VITE_APP_OAUTH_URL=http://localhost:new_port/oauth

  • Change Api.env: OAUTH_CALLBACK="'http://localhost:8080/oauth/callback'" by OAUTH_CALLBACK="'http://localhost:new_port/oauth/callback'"

  • Change EternalTwin/etwin.toml line 82: callback_uri = "http://localhost:8080/oauth/callback" by callback_uri = "http://localhost:new_port/oauth/callback"

License

The source code of this project is licensed under AGPL-3.0-or-later License.

You are free to:

  • Use — run, study, and privately modify the software.
  • Share — copy and redistribute the material in any medium or format.
  • Modify — remix, transform, and build upon the material.

Under the following terms:

  • Source Code Provision — You must provide access to the source code of the software when you distribute it, including any modifications or derivative works.
  • License and Copyright Notice — You must include the original copyright notice and license in any copy of the software or substantial portion of it.
  • State Changes — You must clearly mark any changes you made to the original software.
  • ShareAlike — If you modify and distribute the software, you must license the entire work under the AGPLv3 or a compatible license.
  • Network Use is Distribution — Users who interact with the software via network have the right to receive the source code.
  • No Additional Restrictions — You may not apply legal terms or technological measures that legally restrict others from doing anything the license permits.

All Motion Twin and eMush assets in App/src/assets are licensed under CC-BY-NC-SA-4.0 License.

You are free to:

  • Share — copy and redistribute the material in any medium or format.
  • Adapt — remix, transform, and build upon the material.
  • The licensor cannot revoke these freedoms as long as you follow the license terms.

Under the following terms:

  • Attribution — You must give appropriate credit, provide a link to the license, and indicate if changes were made. You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use.
  • NonCommercial — You may not use the material for commercial purposes.
  • ShareAlike — If you remix, transform, or build upon the material, you must distribute your contributions under the same license as the original.
  • No additional restrictions — You may not apply legal terms or technological measures that legally restrict others from doing anything the license permits. Creative Commons