This project is a website for the Canary project. The main goal is to use modern technology to have something that is easy to maintain and extend. It is also meant to be efficient, secure and easy to deploy.
Clone this repository and install the dependencies:
git clone https://github.com/luan/slenderaac.git
cd slenderaac
pnpm install
cp .env.dist .envEdit .env with your server and desired settings. Then migrate the database using the command below. Note that this assumes your current database already has the canary schema imported.
pnpm migrate:resolve
pnpm migrate
pnpm generateAt this point you should be ready to run the server:
pnpm devDeployment depends highly on your server setup. Assuming you are on a Linux dedicated server or VPS. You need the following:
As well as a database compatible with canary. You can use either MySQL or MariaDB.
sudo apt update
curl -fsSL https://deb.nodesource.com/setup_20.x | sudo -E bash - && sudo apt install -y nodejs
sudo npm install -g pnpm
sudo apt install -y nginxClone this repository and install the dependencies:
git clone https://github.com/luan/slenderaac.git
cd slenderaac
pnpm install
cp .env.dist .envWe're just using Nginx as a reverse proxy. You can use any other web server that supports reverse proxying if you'd like. The Nginx configuration is as follows (adjust port and domain as needed if you're not using the defaults):
server {
listen 80 default_server;
listen [::]:80 default_server;
server_name _;
location / {
proxy_pass http://127.0.0.1:3000;
proxy_http_version 1.1;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection 'upgrade';
proxy_set_header Host $host;
proxy_cache_bypass $http_upgrade;
}
}Because we're now in a production environment, we need to build the project. This will generate the static files that will be served by the nodejs server. This is a one time step, you only need to do this again if you change /update the code.
pnpm generate
pnpm buildAt this point you should be ready to migrate the database. This will create the necessary tables and columns. Note that this assumes your current database already has the canary schema imported.
pnpm migrate:resolve
pnpm migrateFinally, we need to run the server, this will run on port 3000 by defaul, which is what we configured Nginx to proxy to.
NODE_ENV=production node -r dotenv/config buildUsing your favorite method to edit the client (see this tutorial for help). Set the login webservice url to http://localhost:5173/api/login (or your appropraite server URL). This will make the client use the AAC to login.
You'll need to download the spritesheet from here and place it in outfits_anim. These assets are not included in the repository because they can cause the repo to bloat, and are also not release under the same license as the code.
You'll need to download the spritesheet from
here
the items in items. These assets are not included in the repository
because they can cause the repo to bloat, and are also not release under the same license
as the code.
Anything you put into the static folder in this repo will be served by the server. This is useful for storing assets for the game store. For example, you can put a static/images/store folder and then reference the images in the store using /images/store/my-image.png. For instance, you can use the store assets made available in the canary docs
Kapture.2023-06-12.at.16.09.37.mp4
Kapture.2023-06-12.at.16.11.52.mp4
Contributions are welcome! Please open an issue or pull request. Be sure to post screenshots and logs of any issues you're having.
MIT