Skip to content

Commit

Permalink
Readme enhancements and credits addition
Browse files Browse the repository at this point in the history
  • Loading branch information
louis-e committed Jan 12, 2025
1 parent 5e6eb09 commit 3efb846
Show file tree
Hide file tree
Showing 7 changed files with 171 additions and 5 deletions.
27 changes: 23 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<p align="center">
<img width="456" height="125" src="https://github.com/louis-e/arnis/blob/main/gitassets/logo.png?raw=true">
<img width="456" height="125" src="https://github.com/louis-e/arnis/blob/main/gui-src/images/logo.png?raw=true">
</p>

# Arnis [![CI Build Status](https://github.com/louis-e/arnis/actions/workflows/ci-build.yml/badge.svg)](https://github.com/louis-e/arnis/actions) [<img alt="GitHub Release" src="https://img.shields.io/github/v/release/louis-e/arnis" />](https://github.com/louis-e/arnis/releases) [<img alt="GitHub Downloads (all assets, all releases" src="https://img.shields.io/github/downloads/louis-e/arnis/total" />](https://github.com/louis-e/arnis/releases)
Expand Down Expand Up @@ -56,6 +56,12 @@ If you're on Windows, please install the [Evergreen Bootstrapper from Microsoft]
Please use Minecraft version 1.21.4 for the best results. Minecraft version 1.16.5 and below is currently not supported, but we are working on it!
- *The generation did finish, but there's nothing in the world!*<br>
Make sure to teleport to the generation starting point (/tp 0 0 0). If there is still nothing, you might need to travel a bit further into the positive X and positive Z direction.
- *What features are in the world generation settings?*<br>
**Winter Mode:** This setting changes the generation style to a snowy theme and adds snow layers to the ground.<br>
**Scale Factor:** The scale factor determines the size of the generated world.<br>
**Custom BBOX Input:** This setting allows you to manually input the bounding box coordinates for the area you want to generate.<br>
**Floodfill-Timeout (Sec):** This setting determines the maximum time the floodfill algorithm is allowed to run before being terminated. Increasing this value may improve the generation of large water areas but may also increase processing time.<br>
**Ground Height:** This setting determines the base height of the generated world and can be adjusted to create different terrain types.

## :memo: ToDo and Known Bugs
Feel free to choose an item from the To-Do or Known Bugs list, or bring your own idea to the table. Bug reports shall be raised as a Github issue. Contributions are highly welcome and appreciated!
Expand Down Expand Up @@ -111,11 +117,24 @@ After your pull request was merged, I will take care of regularly creating updat
</a>

## :copyright: License Information
This project is licensed under the Apache 2.0 License.[^3]
This GitHub repository is the only official source for the Arnis project. Websites or distributions that claim to be official sources or use the Arnis name, logo, or branding without explicit permission are not allowed and violate the terms of the Apache 2.0 License.

Copyright (c) 2022-2025 Louis Erbkamm (louis-e)

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.[^3]

Download Arnis only from the official source (https://github.com/louis-e/arnis/). Every other website providing a download and claiming to be affiliated with the project is unofficial and may be malicious.
The logo was made by @nxfx21.


[^1]: https://en.wikipedia.org/wiki/OpenStreetMap

[^2]: https://en.wikipedia.org/wiki/Arnis,_Germany
Expand Down
Binary file removed gitassets/logo.png
Binary file not shown.
21 changes: 21 additions & 0 deletions gui-src/css/styles.css
Original file line number Diff line number Diff line change
Expand Up @@ -356,3 +356,24 @@ button:hover {
content: "⚙️";
font-size: 18px;
}

/* Logo Animation */
#arnis-logo {
width: 35%;
height: auto;
opacity: 0;
transform: scale(0);
animation: zoomInLogo 1s ease-out forwards;
}

/* Keyframe Animation */
@keyframes zoomInLogo {
0% {
transform: scale(0);
opacity: 0;
}
100% {
transform: scale(1);
opacity: 1;
}
}
Binary file modified gui-src/images/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
17 changes: 16 additions & 1 deletion gui-src/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,14 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Arnis</title>
<script type="module" src="./js/main.js" defer></script>
<script type="module" src="./js/license.js" defer></script>
</head>

<body>
<main class="container">
<div class="row">
<a href="https://github.com/louis-e/arnis" target="_blank">
<img src="./images/logo.png" class="logo arnis" alt="Arnis Logo" />
<img src="./images/logo.png" id="arnis-logo" class="logo arnis" alt="Arnis Logo" style="width: 35%; height: auto;" />
</a>
</div>

Expand Down Expand Up @@ -118,6 +119,20 @@ <h2 data-localize="customization_settings">Customization Settings</h2>
<label for="ground-level" data-localize="ground_level">Ground Level:</label>
<input type="number" id="ground-level" name="ground-level" min="-64" max="290" value="-62" style="width: 100px;" placeholder="Ground Level">
</div>

<!-- License and Credits Button -->
<button type="button" id="license-button" class="license-button" onclick="openLicense()" data-localize="license_and_credits">License and Credits</button>
</div>
</div>

<!-- License Modal -->
<div id="license-modal" class="modal" style="display: none;">
<div class="modal-content">
<span class="close-button" onclick="closeLicense()">&times;</span>
<h2 data-localize="license_and_credits">License and Credits</h2>
<div id="license-content" style="overflow-y: auto; max-height: 300px; font-size: 0.85em; line-height: 1.3; padding: 10px; border: 1px solid #ccc; border-radius: 4px;">
Loading...
</div>
</div>
</div>

Expand Down
81 changes: 81 additions & 0 deletions gui-src/js/license.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

30 changes: 30 additions & 0 deletions gui-src/js/main.js
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
import { licenseText } from './license.js';

const { invoke } = window.__TAURI__.core;

// Initialize elements and start the demo progress
Expand Down Expand Up @@ -247,6 +249,29 @@ function initSettings() {
slider.addEventListener("input", () => {
sliderValue.textContent = parseFloat(slider.value).toFixed(2);
});


/// License and Credits
function openLicense() {
const licenseModal = document.getElementById("license-modal");
const licenseContent = document.getElementById("license-content");

// Render the license text as HTML
licenseContent.innerHTML = licenseText;

// Show the modal
licenseModal.style.display = "flex";
licenseModal.style.justifyContent = "center";
licenseModal.style.alignItems = "center";
}

function closeLicense() {
const licenseModal = document.getElementById("license-modal");
licenseModal.style.display = "none";
}

window.openLicense = openLicense;
window.closeLicense = closeLicense;
}

function initWorldPicker() {
Expand Down Expand Up @@ -307,6 +332,11 @@ function handleBboxInput() {
const bboxText = `${lat1} ${lng1} ${lat2} ${lng2}`;
window.dispatchEvent(new MessageEvent('message', { data: { bboxText } }));

// Show custom bbox on the map
let map_container = document.querySelector('.map-container');
map_container.setAttribute('src', `maps.html#${lat1},${lng1},${lat2},${lng2}`);
map_container.contentWindow.location.reload();

// Update the info text
bboxInfo.textContent = window.localization.custom_selection_confirmed;
bboxInfo.style.color = "#7bd864";
Expand Down

0 comments on commit 3efb846

Please sign in to comment.