This project is open-source, and contributions are welcome. In fact, the Atlas relies on user contributions.
You may contribute to the project by submitting a Pull Request on the GitHub repo or sending your submissions through [Lemmy](https://toast.ooo/c/2024lemmycanvasatlas). Other than that, you can get help from [Matrix](https://matrix.to/#/#lemmy-canvas-atlas-discussion:mariusdavid.fr) or [Lemmy](https://toast.ooo/c/2024lemmycanvasatlas).
You may contribute to the project by sending your submissions through Lemmy ([2024](https://toast.ooo/c/2024lemmycanvasatlas) or [2025](https://toast.ooo/c/2025fedicanvasatlas)) (recommended) or submitting a Merge Request on the Gitlab repo. Other than that, you can get help from [Matrix](https://matrix.to/#/#lemmy-canvas-atlas-discussion:mariusdavid.fr) or the lemmy community.
## New Atlas entries
To contribute to the map, we require a certain format for artwork region and labels. This can be generated on [the drawing mode](https://atlas.mariusdavid.fr/?mode=draw) on the website.
To contribute to the map, we require a certain format for artwork region and labels. This can be generated on the drawing mode ([2024](https://atlas.mariusdavid.fr/?mode=draw)or [2025](https://atlas2025.mariusdavid.fr/?mode=draw)) on the website.
To add a new entry, go to [the drawing mode](https://atlas.mariusdavid.fr/?mode=draw) and draw a shape/polygon around the region you'd like to describe. You can use the <kbd>Undo</kbd>, <kbd>Redo</kbd>, and <kbd>Reset</kbd> buttons to help you creating a good polygon. Make sure that the lines you're drawing don't form a [self-intersecting polygon](https://upload.wikimedia.org/wikipedia/commons/thumb/0/0f/Complex_polygon.svg/288px-Complex_polygon.svg.png).
To add a new entry, go to the drawing mode and draw a shape/polygon around the region you'd like to describe. You can use the <kbd>Undo</kbd>, <kbd>Redo</kbd>, and <kbd>Reset</kbd> buttons to help you creating a good polygon. Make sure that the lines you're drawing don't form a [self-intersecting polygon](https://upload.wikimedia.org/wikipedia/commons/thumb/0/0f/Complex_polygon.svg/288px-Complex_polygon.svg.png).
You can also edit existing entries. To do that, [enter the normal mode](https://atlas.mariusdavid.fr/), select the entry you want to edit, then click `Edit`. To retrace it, you can click `Add Period`, then `Delete` the old first Period.
If you want to see which areas of the canvas do not have entries yet, select "Highlight Empty" to hide areas that already have entries.
Multiple periods can be added to represent the changing state of the artwork on different times. You can set the start and end period of the canvas. You can also copy the polygon from one period to the other, duplicating a period to be edited later, as well as deleting a period (if there is more than one). An alert is also shown if there are errors that needed attention.
When you're happy with the shape you've drawn, press <kbd>Finish</kbd>. You will now be able to enter some information about the entry:
-**Name**: A short, descriptive name.
@@ -27,17 +29,17 @@ When you're happy with the shape you've drawn, press <kbd>Finish</kbd>. You will
All fields but the name are optional. For example, a country flag doesn't necessarily need a description.
Once you've entered all the information, you'll be presented with a pop-up window containing some [JSON](https://en.wikipedia.org/wiki/JSON)-formatted data. This is the patch that you are going to submit. Depending on the method, there are two preferred methods.
Once you've entered all the information, you'll be presented with a pop-up window containing some [JSON](https://en.wikipedia.org/wiki/JSON)-formatted data. This is the patch that you are going to submit.
### Through Lemmy
### Through Lemmy (Recommended)
You will need to post that message to the `!2024lemmycanvasatlas@toast.ooo`community via Lemmy (or another Activity-Pub powered service that allow long enought messages).
You will need to post that message to the community (`!2024lemmycanvasatlas@toast.ooo`for 2024 or `!2025fedicanvasatlas@toast.ooo`) via Lemmy (or another Activity-Pub powered service that allow long enought messages).
Past the whole JSON file in the body, and then post it. Eventually, a bot should answer that your post has been processed (or not) in less than 30 minutes. If that does not happen after 1 hour, then this is a bug, and you can report it. You can also use the second contributionn method.
Paste the whole JSON file in the body, and then post it. Eventually, a bot should answer that your post has been processed (or not) in less than 30 minutes. If that does not happen after 1 hour, then this is a bug, and you can report it. You can also use the second contributionn method.
### Through the forge
If you know about Git, and know how to create a pull request on GitLab, you can create a patch that will be merged as-is in the repo.
If you know about Git, and know how to create a merge request on GitLab, you can create a patch that will be merged as-is in the repo.
For that, you first need to create an account on the forge used, [git.sc07.company](https://git.sc07.company), if you do not already have one. This instance is managed by grant, and have manual approval to avoid spam.
@@ -46,6 +48,8 @@ The, you can fork the repository, create a local clone of it, and then:
- If you create a new entry, just crate a new file ending in .json in that folder, and paste the JSON
- If you modify an existing entry, find the file with the same "id" in it, and replace it with the JSON
Please note that `entries/` if for 2024 and `entries2025` for 2025.
The commit message and description doesn't matter, but you may change it into something more descriptive to make it easier for checking (e.g. <kbd>Add Foo Bar</kbd> or <kbd>Edit Foo Bar</kbd> for the commit message). However, we suggest you to edit the title (at least) and the description of the pull request, containing the changes that you want to do (something like <kbd>Add Foo Bar</kbd> or <kbd>Edit Foo Bar</kbd> for the title, similar to the commit message, is also sufficient).
Once you have successfully created the patch, the file can be committed, and a pull request towards the `main` branch can be created. A member will merge the pull request if it is adequate.
@@ -6,7 +6,7 @@ This project is a fork of the [2023 r/place Atlas](https://github.com/placeAtlas
This project is licensed under the [GNU Affero General Public License v3.0](LICENSE).
You can check out the website by visiting [this page for 2024](https://atlas.mariusdavid.fr/) and [this page for 2025](https://atlas.mariusdavid.fr/). We also have [Matrix room](https://matrix.to/#/#lemmy-canvas-atlas-discussion:mariusdavid.fr) or one the lemmy community [for 2024](https://toast.ooo/c/2024lemmycanvasatlas) or [2025](https://toast.ooo/c/2025fedicanvasatlas).
You can check out the website by visiting [this page for 2024](https://atlas.mariusdavid.fr/) and [this page for 2025](https://atlas2025.mariusdavid.fr/). We also have [Matrix room](https://matrix.to/#/#lemmy-canvas-atlas-discussion:mariusdavid.fr) or one the lemmy community [for 2024](https://toast.ooo/c/2024lemmycanvasatlas) or [2025](https://toast.ooo/c/2025fedicanvasatlas).