Update docu #1147
Update docu #1147
Conversation
| ```bash | ||
| curl --proto '=https' --tlsv1.2 -sSf -L https://install.determinate.systems/nix | sh -s -- install | ||
| ``` | ||
|
|
||
| The installer will ask you for the sudo password, and then print the details about what steps it will perform to install Nix. You have to accept this to proceed with the installation. |
There was a problem hiding this comment.
Why do we remove this? Doesn't the installation ask you for super user (sudo) privileges? It's unsafe to enable sudo to a dependency we don't know, here we tell the user that it's normal for Nix to ask you for sudo privileges.
|
|
||
| Make sure there weren't any errors during the installation and, if there are none, close the shell and start a new one. |
There was a problem hiding this comment.
This is important in my opinion. We have to make sure the user reads the terminal instead of copy-pasting commands and closing then opening terminals without reading the output of the commands ran.
|
|
||
| Make sure there weren't any errors during the installation and, if there are none, close the shell and start a new one. | ||
|
|
||
| To test if Nix generally works, just run GNU hello or any other package: |
There was a problem hiding this comment.
I wouldn't delete this, a User may want to know what nixpkgs#hello is before running.
| - **Devenv:** | ||
| ## 2. Install Devenv | ||
|
|
||
| After installing Nix, run: |
There was a problem hiding this comment.
We don't mention devenv here. The following command has nothing to do with nix, it installs devenv.
I think the old message was ok, we have to tell the user that:
NixMUST be installed before devenv (devenv depends on nix)- the following command installs devenv.
| ```bash | ||
| nix-env -if https://install.devenv.sh/latest | ||
| ``` | ||
|
|
||
| For devenv to manage caches for you, add yourself to trusted-users in nix conf: | ||
| Then, add yourself as a trusted user in the Nix configuration: |
There was a problem hiding this comment.
Why remove the caches explanation? It's a good habit to explain the user why they should follow the commands we state here.
|
|
||
| Then, open: |
There was a problem hiding this comment.
Why? This is not mandatory. It's just to play a game.
| To access the Elixir console: | ||
|
|
||
| If you want to have access to the Elixir console, instead do: | ||
| ```bash | ||
| devenv shell postgres | ||
| # Then in another terminal: | ||
| ``` | ||
|
|
||
| In another terminal, run: | ||
|
|
||
| ```bash | ||
| devenv shell | ||
| make start | ||
| ``` |
There was a problem hiding this comment.
This is an alternative to devenv up, I liked the former comment where the user can know he can either do devenv up or devenv shell postgress + devenv shell && make start in separate terminals.
| devenv shell | ||
| make start | ||
| ``` | ||
| _Note you need to have ran `devenv up` earlier._ | ||
|
|
||
| ⚠️ **Note:** Make sure you’ve run `devenv up` before these commands. |
There was a problem hiding this comment.
| ⚠️ **Note:** Make sure you’ve run `devenv up` before these commands. | |
| ⚠️ **Note:** Make sure you’ve run `devenv up` at least once before executing these commands. |
| Its mandatory to activate a character to have a basic skin assigned, for example, if you want to add Uren you should add this this lines of code: | ||
|
|
||
| - Set `active` to `true` in `seeds.exs` | ||
| charactername_params = %{ | ||
| name: "valtimer", | ||
| active: true, | ||
| ... | ||
| ... | ||
| } |
There was a problem hiding this comment.
A few things here:
- This README is for the Configurator app. It's documentation to add/edit characters via the forms in
localhost:4100, not the seeds. - You can either add a character via Configurator or by code using seeds.
Theactiveparam is the one that enables and disables characters, but it's already been said above:
- Change it's
activevalue to enable/disable characters in game.
- Also, you talk about Uren but the params are for Valtimer.
| - 4.2 Create a default skin (if needed) | ||
| charactername_basic_params = %{ | ||
| is_default: true, | ||
| name: "Basic", | ||
| character_id: Enum.find(characters, fn c -> c.name == "charactername" end).id | ||
| } | ||
| - Add `charactername_basic_params` to the skins list | ||
| Find the **Insert skins** section and add the new character's basic skin: | ||
|
|
||
| Insert skins | ||
| [ | ||
| h4ck_fenix_params, | ||
| h4ck_basic_params, | ||
| valtimer_frostimer_params, | ||
| valtimer_basic_params, | ||
| kenzu_black_lotus_params, | ||
| kenzu_basic_params, | ||
| otix_corrupt_underground, | ||
| otix_basic_params | ||
| ] |
There was a problem hiding this comment.
Maybe we can replace all this by just saying that if you create a new character, you have to assign a default skin to it or it won't work, then show how to do it (like you do here).
Also, it would be nice to mention that this should be in the Configurator (again, these are Configurator's app docs), because now you can't create skins from it. If you add that, create an issue and link it here as well.
Also please update your PR description, because the steps you mention doesn't apply to this PR |
Motivation
Updated the Mirra backend setup documentation. Added detailed steps for installing Nix, Devenv, Protobuf, and dependencies for Elixir and JavaScript Protobuf, along with instructions to properly start the services. >
Created documentation for enabling disabled characters. Key steps include: