armus,apix0n

🌹 Armus is a project that I created with a friend in the hope to create an "army" of amogi.

📕 Definitions

amogus /aˈmoɡɪs, aˈmoɡus/
noun
1/ An edited crewmate or impostor from the videogame Among Us.
2/ Misspelling/slang of the videogame Among Us.

amogi /aˈmoɡɪ/
plural noun
1/ Edited crewmates or impostors from the videogame Among Us.

🏅 Achievements

❓ How to see the characters?

Go to https://apix0n.github.io/Armus and select your preferred language,

Below the icon on the top of the README, click on a button to go to your preferred language.

📁 What are all those folders?

Armus
├── .github                     <--- GitHub files
│   └── ISSUE_TEMPLATE          <--- Issue templates
│
├── en                          <--- English version of the website
│   └── character               <--- Character guide in English
│
├── fr                          <--- French version of the website
│   └── character               <--- Character guide in French
│
├── other
│   ├── achievements            <--- Medals (.png)
│   ├── achievements-psd        <--- Medals (.psd)
│   ├── buttons                 <--- README buttons (.png)
│   ├── buttons-psd             <--- README buttons (.psd)
│   ├── create-a-character      <--- Resources to create the characters
│   └── icons-psd               <--- Icons (.psd)
│
├── pics                        <--- Images of the characters (.jpeg)
│
└── tr                          <--- Turkish version of the website

🎨 How to add a character

Example with the character: "termius"

Open /db.json
Gather the following informations:
- The character's name (required),
- The artist's ID (if you don't know what I'm talking about, check "How to add an artist" below "How to add a character") (required),
- The image of the character (required),
- The date when the artist drew the character or when you're adding it (required),
- The GitHub "AddCharacter" issue number,
- The GitHub "Idea" issue number,
Find the place where the character will be (the characters need to be sorted alphabetically).

Here, the character's name is "termius", so it will be placed between "tchoupius" and "tetrus".

"characters": [
    ...
  },
  {
    "name": "talecramptus",
    "artist": "Kooki",
    "image": "../pics/talecramptus.jpeg",
    "date": "04/07/2023"
  },
  {
    "name": "tchoupius",
    "artist": "Aliko",
    "image": "../pics/tchoupius.jpeg",
    "date": "29/06/2022"
  },
  // INDICATION: This is where the character will be placed. 
  {
    "name": "tetrus",
    "artist": "Kooki",
    "image": "../pics/tetrus.jpeg",
    "date": "05/04/2023"
  },
  {
    "name": "the-creatorus",
    "artist": "Chus",
    "image": "../pics/the-creatorus.jpeg",
    "date": "20/06/2022"
  },
  {
    ...
]

Add the character in the right place to db.json.

"characters": [
    ...
  },
  {
    "name": "talecramptus",
    "artist": "Kooki",
    "image": "../pics/talecramptus.jpeg",
    "date": "04/07/2023"
  },
  {
    "name": "tchoupius",
    "artist": "Aliko",
    "image": "../pics/tchoupius.jpeg",
    "date": "29/06/2022"
  },
  // INDICATION: These are the lines you are adding.
  {
    "name": "termius",  // Replace "termius" by the name of the character
    "artist": "Apix",   // Replace "Apix" by the ArtistID 
    "image": "../pics/termius.jpeg", // Replace by the path of the image
    "date": "04/07/2023" // Replace by the date when the artist drew the character or when you're adding it
  }, 
  // INDICATION: Don't forget to add the comma after the ending bracket.
  {
    "name": "tetrus",
    "artist": "Kooki",
    "image": "../pics/tetrus.jpeg",
    "date": "05/04/2023"
  },
  {
    "name": "the-creatorus",
    "artist": "Chus",
    "image": "../pics/the-creatorus.jpeg",
    "date": "20/06/2022"
  },
  {
    ...
]

Save your changes.
Verify that /db.json is valid using https://jsonlint.com.

✉ How to add an artist

Example with the artist: "EL MALADO"

Open /db.json.
Find the place where the artist should be (the artists are not sorted, add the artist after the last one).

"artists": [
  ...
  },
  {
    "id": "Jiwon",
    "prettyname": "Jiwon",
    "rank": 0
  },
  {
    "id": "GaimeLeZuitres",
    "prettyname": "GaimeLéZuitres",
    "rank": 0
  } // INDICATION: The artist will be added after this bracket.
],
  ...

Place the artist:

"artists": [
  ...
  },
  {
    "id": "Jiwon",
    "prettyname": "Jiwon",
    "rank": 0
  },
  {
    "id": "GaimeLeZuitres",
    "prettyname": "GaimeLéZuitres",
    "rank": 0
  }, // INDICATION: Don't forget to add the comma after the ending bracket.
  { // INDICATION: These are the lines you are adding.
    "id": "EL-MALADO", // This is the ArtistID. Repalce it by a string which doesn't have special characters nor spaces (only hyphens are allowed).
    "prettyname": "EL MALADO", // Replace this by the name that will be shown on the website.
    "rank": 0 // This is the rank of the artist. See "Artist ranks" below for more informations.
  }
],
  ...

Save your changes.
Verify that /db.json is valid using https://jsonlint.com.

🌟 Artist ranks

There are currently 5 artist ranks in Armus. They add style and color to the website.

0, no class, less than 10 characters, no emoji, no color.
1, .rank1, from 10 to 19 characters, 👑, golden name for the artist.
2, .rank2, from 20 to 29 characters, 💎, blue name for the artist.
3, .rank3, from 30 to 39 characters, 🌹, red name for the artist.
4, .rank4, from 40 to 49 characters, 🍀, green name for the artist.
There is an exception for Apix that will not add an emoji but add the Apix icon instead.

Where are the colors shown?

The ranks are shown in each character card, where each artist's name is colored and emoji'd according to their rank.

The ranks are shown in the overlay when you tap/click on a charcter card. It colors the bottom right gradient, the close button and the name has the corresponding emoji.

The ranks are shown on the artist names. They are colored and the name has the corresponding emoji.

📖 The Armus Alphabet

Armus has characters that start with the letters:

✨ Useful links

ℹ️ Other

If you want to create a character, look at https://apix0n.github.io/Armus/en/character,
If you want to do other modifications, look at https://apix0n.github.io/Armus/en#problem,
If you want to reuse this project, mention my name and Armus' on the README and the website.

Armus by is licensed under CC BY-NC-SA 4.0

apix0n / armus Goto Github PK

armus's Introduction

🌹 Armus is a project that I created with a friend in the hope to create an "army" of amogi.

📕 Definitions

🏅 Achievements

❓ How to see the characters?

📁 What are all those folders?

🎨 How to add a character

✉ How to add an artist

🌟 Artist ranks

📖 The Armus Alphabet

✨ Useful links

ℹ️ Other

armus's People

Contributors

Stargazers

Watchers

armus's Issues

🤺 Ajouter un personnage

L'image:

Le nom du personnage:

Votre nom dans les remerciements:

🤺 Ajouter un personnage

L'image:

Le nom du personnage:

Votre nom dans les remerciements:

🤺 Ajouter un personnage

L'image:

Le nom du personnage:

Votre nom dans les remerciements:

🤺 Ajouter un personnage

L'image:

Le nom du personnage:

Votre nom dans les remerciements:

🤺 Ajouter un personnage

L'image:

Le nom du personnage:

Votre nom dans les remerciements:

🤺 Ajouter un personnage

L'image:

Le nom du personnage:

Votre nom dans les remerciements:

🤺 Ajouter un personnage

L'image:

Le nom du personnage:

Votre nom dans les remerciements:

🤺 Ajouter un personnage

L'image:

Le nom du personnage:

Votre nom dans les remerciements:

🤺 Ajouter un personnage

L'image:

Le nom du personnage:

Votre nom dans les remerciements:

🤺 Ajouter un personnage

L'image:

Le nom du personnage:

Votre nom dans les remerciements:

🤺 Ajouter un personnage

L'image:

Le nom du personnage:

Votre nom dans les remerciements:

Character name:

Write a detailed description of the character

Describe the background

🤺 Ajouter un personnage

L'image:

Le nom du personnage:

Votre nom dans les remerciements:

🤺 Ajouter un personnage

L'image:

Le nom du personnage:

Votre nom dans les remerciements:

Recommend Projects

Recommend Topics

Recommend Org