Skip to content

Commit

Permalink
Merge pull request #112 from planetarium/docs/applying-weapon-crafters
Browse files Browse the repository at this point in the history
docs: applying `Weapon Crafters` track to `2024 Modathon`
  • Loading branch information
boscohyun authored Nov 8, 2024
2 parents cd2506b + 8a7aab3 commit 9049a70
Show file tree
Hide file tree
Showing 9 changed files with 183 additions and 55 deletions.
11 changes: 9 additions & 2 deletions .vitepress/config/en.mts
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,15 @@ function nav(): DefaultTheme.NavItem[] {

function sidebarEvent(): DefaultTheme.SidebarItem[] {
return [
{ text: '2024 Modathon', link: 'event/2024modathon' },
{ text: 'Non Developer Guide', link: 'event/for-non-developer' }
{
text: '2024 Modathon',
link: 'event/2024modathon',
collapsed: false,
items: [
{ text: 'Beginner\'s Guide', link: 'event/for-non-developer' },
{ text: 'Weapon Crafter\'s Guide', link: 'event/for-weapon-crafter' },
]
},
];
}
function sidebarGuide(): DefaultTheme.SidebarItem[] {
Expand Down
1 change: 1 addition & 0 deletions .vitepress/config/index.mts
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import { en } from './en.mts';

export default defineConfig({
...shared,
ignoreDeadLinks: false,
locales: {
root: { label: 'English', ...en },
ko: { label: 'Korean', ...ko }
Expand Down
11 changes: 9 additions & 2 deletions .vitepress/config/ko.mts
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,15 @@ function nav(): DefaultTheme.NavItem[] {

function sidebarEvent(): DefaultTheme.SidebarItem[] {
return [
{ text: '2024 Modathon', link: 'event/2024modathon' },
{ text: '비개발자 가이드', link: 'event/for-non-developer' }
{
text: '2024 모다톤',
link: 'event/2024modathon',
collapsed: false,
items: [
{ text: '초보자 가이드', link: 'event/for-non-developer' },
{ text: '무기 제작자 가이드', link: 'event/for-weapon-crafter' },
]
},
];
}

Expand Down
42 changes: 29 additions & 13 deletions en/event/2024modathon.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,35 @@
![2024modathon](</images/event/2024modathon/2024modathon.png>)

# **Modathon Overview**
# **Modathon**

[Nine Chronicles](https://docs.nine-chronicles.com/introduction) is a decentralized idle RPG built on blockchain technology.
Over time, the community has created many exciting mods, and now, we want to see even more contributions. To support this, we're launching the **Nine Chronicles Modathon** with a prize pool of **225,000 NCG**.

We’ve developed new tools to make modding easier, and even **non-developers** can participate with our beginner-friendly tutorials. Join us in shaping the future of Nine Chronicles and bring your ideas to life! 🎮✨
We've written several documents to make modding easier, so check them out:
- [beginner's guide](./for-non-developer) so that **beginners** can participate.
- For **weapon crafters**, we've created a [guide for weapon crafters](./for-weapon-crafter).

# **Purpose of the Modathon**
Let's shape the future of Nine Chronicles together and turn your ideas into reality!🎮✨

## **Purpose of the Modathon**

The primary goal of the Nine Chronicles Modathon is to **strengthen** the Nine Chronicles modding ecosystem and **grow the number of community developers**. We hope that the projects created during the Modathon will **continue to evolve** and be used long after the event ends. 🚀

Additionally, since all Nine Chronicles-related products are open-source, we encourage participants to **contribute to them**, fostering a collaborative and ongoing development process.

# **Modathon Detail**
## **Modathon Detail**

### **Introduction to the Modathon**

The Modathon is **a type of hackathon** where participants compete by creating mods.
**Aim for first place by making a mod that players will love!** 🏆

Participants can create **any type of mod related to Nine Chronicles**, whether it’s a website, client modification, or any other kind of mod.
You can make **any kind of mod related to Nine Chronicles**. Feel free to create mods for websites, client modifications, weapon images, and more.
**Promote your mod** during the event to earn positive feedback from the community. 📣

**Seven days before the event concludes**, we’ll hold a **community vote** to see which mod is most popular among users. The results will serve as a reference for the judging process, with internal rankings determining the final rewards.

There are **no genre restrictions** for mods—whether it's a website or a client modification, everything is welcome. And if you're not a developer but want to participate and **learn to develop** as you go, be sure to check out our [Non Developer Guide](./for-non-developer.md) for help. 💡
There are **no genre restrictions** on mods - website or client modifications are all welcome. If you're not a developer but want to **learn to develop and get involved**, check out the [beginner's guide](./for-non-developer), and if you want to **create weapons and get involved**, check out the [weapon crafter's guide](./for-weapon-crafter). 💡

### **How to Participate**

Expand All @@ -36,38 +40,47 @@ For event-related questions, a Q&A channel will be available `#2024modathon` on

💡 **Have a mod idea?** Feel free to post it in the `#mod-ideas` channel on the **Planetarium Dev or Planetarium** server, where you can also find developers to collaborate with!

# **Submission Guidelines**
🛠️ **Submit your mod** through the **BUIDLs section** on [DoraHacks](https://dorahacks.io/hackathon/planetarium-2024modathon/detail), and make sure to include the link to your Git repository (e.g., GitHub, GitLab). The repository’s `README.md` **must contain a clear description of your mod**.
## **Submission Guidelines**
You can participate via the **Submit BUIDL** button on 🛠️ [DoraHacks](https://dorahacks.io/hackathon/planetarium-2024modathon/detail):
- **Mod Builders**: When submitting, you must include a link to your Git repository (GitHub, GitLab, etc.) and the `README.md` of your repository must have a **clear description of the mod**.
- **Weapon Crafters**: In your submission, you must either directly include the image files of the weapon you created or include a URL where the image files of the weapon can be downloaded, include a description of the weapon you created, and, if applicable, include the source and copyright information for the original images of the weapon you submitted.

To ensure we have the necessary information for distributing rewards, please **click the "Register as Hacker" button** and fill out the required details in the linked Google Form.

You can join the event **at any time during the competition period**, even if your mod isn’t fully completed. Simply submit it with a description. However, at the event's conclusion, we will assess the submission to determine **whether it qualifies for participation** based on its completeness, to **prevent abuse**.

**Mod Builders**:
- Projects created **before September 2024** are not eligible unless they include **significant new features** added after this date.
- Teams may work on one project together, but **only the individual who submits the project** will receive the rewards.
- **All submissions** must be **open-source** and use an appropriate license, such as **GPL or AGPL**.
- Registrations can be submitted at any time until the end of the competition, but we **encourage early registration** before **October 1** to help ensure a smooth event process.
- If your mod **violates any copyright regulations**, it may be disqualified from the evaluation process.

# **Timeline**
**Weapon Crafters**:
- All legal responsibility for submitted weapon images rests with the submitter.
- We will not accept artwork that is half-assed for copyright or licensing purposes.
- We will not accept submissions that may be considered socially offensive.

## **Timeline**

📅 The Nine Chronicles Modathon will take place from **October 1, 2024 – December 31, 2024**.

# **Prizes** 🏅
## **Prizes** 🏅

🥇 **1st Prize**: **100,000NCG** with **1120 Golden Dust**, **400 AP Potion**, **80,000 Hourglass**
🥈 **2nd Prize**: **70,000NCG** with **560 Golden Dust**, **200 AP Potion**, **40,000 Hourglass**
🥉 **3rd Prize**: **35,000NCG** with **280 Golden Dust**, **100 AP Potion**, **20,000 Hourglass**
🎖️ **4th Prize**: **15,000NCG** with **140 Golden Dust**, **50 AP Potion**, **10,000 Hourglass**
🎖️ **5th Prize**: **5,000NCG** with **100 Golden Dust**, **50 AP Potion**, **10,000 Hourglass**
😁 **All participants**: **100NCG** + **200 Golden Dust**, **100 AP Potion**, **20,000 Hourglass**
😁 **All Mod Builders**: **100 NCG** + **200 Golden Dust** + **100 AP Potion** + **20,000 Hourglass**
😁 **All Weapon Crafters** (first 50 entries): **100 NCG** + **200 Golden Dust** + **100 AP Potion** + **20,000 Hourglass**

::: danger :construction:
All participants will receive an item reward, but if any form of **abuse is detected**, the reward may be **revoked** after internal review.
Participation rewards will only be granted if the submitted project is **functional**. Projects that are incomplete or do not meet the **minimum requirements** may be excluded from receiving rewards.
:::

# **Judging Criteria** ⚖️
## **Judging Criteria** ⚖️

The judging for the Nine Chronicles Modathon will be conducted by the **Planetarium team**, based on the following criteria:

Expand All @@ -77,7 +90,10 @@ The judging for the Nine Chronicles Modathon will be conducted by the **Planetar
2. **New Client Development** 💻
Bonus points will be awarded for attempts to create **new clients** using technologies other than Unity, such as **Godot** or **HTML**.

# **Further more** 💡
3. **Special Weapons** ⚔️
Bonus points for cool weapons with a story that fits plausibly into the Nine Chronicles universe.

## **Further more** 💡

Are you interested in the **Modathon**? 😎 We recommend starting with the [guide to build avatar information website](../tutorials/modding/avatar-information-dapp-guide.md) and [guide to build daily reward website](../tutorials/modding/daily-reward-dapp.md).
Discover community projects at [awesome-9c](https://github.com/planetarium/awesome-9c) and **introduce your projects**!
Expand Down
4 changes: 2 additions & 2 deletions en/event/for-non-developer.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Welcome Non-Developers to the 2024 Modathon! 🎉
# Welcome beginners to the 2024 Modathon! 🎉

Hello and welcome to all non-developers who are interested in participating in the Nine Chronicles Modathon! Don't worry if you're new to coding—by following this guide, you'll be able to create a simple website that displays Nine Chronicles avatar information. 🌟
Hello and welcome to all beginners who are interested in participating in the Nine Chronicles Modathon! Don't worry if you're new to coding—by following this guide, you'll be able to create a simple website that displays Nine Chronicles avatar information. 🌟

Once you've followed through to the end, if you feel inspired, we encourage you to join the Modathon and submit your project. And if you have a cool mod idea but think it's too challenging, head over to the **#mod-ideas** channel in our Discord to find developers who can help bring your vision to life!

Expand Down
40 changes: 40 additions & 0 deletions en/event/for-weapon-crafter.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# Welcome Weapon Crafters to the 2024 Modathon! 🎉

Welcome to the Nine Chronicles Modathon, Weapon Crafters! If you're new to weapon crafting, we've got you covered with image specifications and formats, and even how to view them in-game! 🌟

By the end of this guide, you should be able to join the Modathon and start submitting your weapon images right away. If this seems too difficult, don't worry, you can collaborate with the developers in the **#2024modathon** channel on Discord!

## Weapon Crafting

Gather the tools and materials you need to craft your own weapon, and get creative with your ideas.

- Weapon images should be rotated 90 degrees to the right and have a transparent background.
- File type: PNG
- Suggested size: Around 300 pixels wide and 100 pixels tall.

::: tip
See the example image in [this article](https://github.com/planetarium/NineChronicles.Mods/blob/main/NineChronicles.Mods.Illusionist/README.md#change-weapon-image).
:::

## Apply Weapon via Illusionist Mode

### Install Nine Chronicles

- Installing Nine Chronicles at https://nine-chronicles.com/start

### Running Nine Chronicles

- Run the Nine Chronicles launcher you installed to run Nine Chronicles and verify that it works.
- After confirmation, exit the Nine Chronicles client. You do not need to exit the launcher.

### Installing Illusionist Mode

For instructions on how to install the Illusionist mod, see the [Install and run](https://github.com/planetarium/NineChronicles.Mods/blob/main/NineChronicles.Mods.Illusionist/README.md#install-and-run) section of the mod repository documentation.

### Applying Weapons

To learn how to apply weapons through the Illusionist mod, please see the [Replace weapon image](https://github.com/planetarium/NineChronicles.Mods/blob/main/NineChronicles.Mods.Illusionist/README.md#replace-weapon-image) section of the mod repository documentation.

## Register a Modathon

To register for the modathon, please see the [Submission Guidelines](./2024modathon#submission-guidelines) section of the main body.
Loading

0 comments on commit 9049a70

Please sign in to comment.