×
Create a new article
Write your page title here:
We currently have 3,277 articles on YumeWiki. Type your article name above or click on one of the titles below and start writing!



YumeWiki
3,277Articles

Content Contribution Guidelines: Difference between revisions

The Style Guide has recently been rewritten. Please take a moment to review the new guidelines.

mNo edit summary
(discord link)
 
(28 intermediate revisions by 13 users not shown)
Line 1: Line 1:
A set of guidelines for non-Japanese speaking developers, as well for developers who don't have access to posting on 5ch due to lacking premium pass or a Japanese IP.
==Introduction==
The official platform where information regarding Yume 2kki's development is published is the [https://wikiwiki.jp/yumenikki-g3/ production wiki], also known as the Japanese Yume 2kki development wiki ("ゆめにっきっぽいゲームを作るスレ まとめ Wiki*"). As such, it should be noted that YumeWiki is to be treated as a secondary and derivative resource created and managed by the English-speaking community.


Originally written by 2i9 of the Yume 2kki production team, translated by BSL and +0 Abyss.
This page aims to help prospective and current developers, particularly within the international community, by signposting the game's official policies, procedures, and guidelines for contribution, especially within the context of proxy implementation. It supersedes the original [[Yume 2kki:Content Contribution Guidelines/Legacy Guidelines|Content Contribution Guidelines]] page, preserved for historical purposes.


==Preface==
===What is Yume 2kki?===
Yume 2kki is a massive project, maintaining which in order is no simple task. However, it is also a collaborative project open to everyone willing to cooperate. In spirit of that, a set of guidelines for developers not speaking Japanese was devised. Make sure to follow those for a good experience of contributing content to the game!
''Yume 2kki'' is a fangame of KIKIYAMA's ''[[Yume Nikki:Yume Nikki|Yume Nikki]]'', collaboratively developed by enthusiasts of ''Yume Nikki'', inspired by said game. As such, despite the name, it is not a sequel to ''Yume Nikki''. Its development began in 2007 and originated in 2ch, now 5ch, a Japanese anonymous message board, where development is still continuing, primarily by Japanese developers.


==Rules==
The game's premise is to explore an expansive dream world, with no explicit goal given to players, leaving players to decide on how to enjoy the game entirely.
In order for overseas<ref>"overseas" in this context means any country that isn't Japan.</ref> developers to join the production of Yume 2kki, either of these rules must be followed:


#The overseas dev collaborates with an active producer on the team and sends the update content to them. Japanese producer (referred to as "proxy" in this case) will then post the update on the other party's behalf.
==Rationale==
#The compiled maps, graphics, sounds and BGM are uploaded onto the game's content repository<ref>See [https://wikiwiki.jp/yumenikki-g3/FrontPage/%E3%81%86%EF%BD%90%E3%83%AD%E3%83%80%E7%BE%A4 this] page for details on game's repositories.</ref> (aka, "loader"). From there, an active producer may volunteer to implement the content in the game.
With the rise of international contributors to ''Yume 2kki'', which is a Japanese project, it should be clear that smooth collaboration towards its development requires proper communication. To that end, the need for cooperation with non-native English-speaking Japanese developers and communities is highly important, and proxy implementation procedures fulfil that need, in the face of existing language barriers.  


Furthermore, these policies must be observed:
The policies, procedures, and guidelines as laid out in the production wiki aim to:
===Rules Concerning Tools===
You should use RPG Maker 2000 when editing Yume 2kki.
Other tools (such as RPG Maker 2003 and WOLF RPG Editor) cannot be used to edit maps for Yume 2kki.


===Rules Concerning Expression===
# Reduce the burden on Core Developers by defining workflows and scopes for Associate Developers in documenting, preparing, and developing their content,
These expressions should not be used when editing maps for Yume 2kki.
# Bridge the gap in understanding edits between Core and Associate Developers, and
*Political expression
# Outline shared information between Core and Associate Developers, where Core Developers serve as proxies to Associate Developers, who request the former to formally implement their content.
*Pornographic expression
*Religious expression
*Excessively violent expression
*Expressions that infringe the copyrights of others
*Expressions reminiscent of real events (except historical events)


===Rules for Editing===
==Resource Links==
#Editing maps created by other authors is prohibited as maps you want to edit are not subject to Six-Month Rule, however, this section does not apply to maps where editing permissions have been granted by their original authors.
The wiki that manages information on Yume 2kki's production projects is [https://wikiwiki.jp/yumenikki-g3/ ゆめにっきっぽいゲームを作るスレ まとめ Wiki* (the Japanese Yume 2kki development wiki)].
#Don't create events such as:
*Battle Events
*Events that change Urotsuki's level or parameters


===Six-Month Rule===
In addition, official discussion of the production takes place in the production wiki itself and in threads [https://wikiwiki.jp/yumenikki-g3/%E9%81%BF%E9%9B%A3%E6%89%80 避難所 (Shelter)] and their 5ch thread.
#Anyone can edit a map if the original author has not updated it for more than six months. However, when editing a map, it should be done with respect to the original author's idea(s).
#When you edit a map created by another developer based on this rule, the changes should be kept to a minimum.
#The following maps are not subject to the Six-Month Rule and are protected:
*[[:Category:Wataru|wataru]]'s maps
*[[:Category:Yeris|Yeris]]' maps
*[[:Category:Anon|Anon]]'s maps (except MAP0734)
*[[:Category:Nantai|Nantai]]'s maps (except MAP1102)
*MAP0134
*MAP0176
*MAP0191
*MAP0800
*MAP0804
*MAP0808
*MAP0832~0838
*MAP0840~0845
*MAP0854~0855
*MAP0877~0880
*MAP0886~0887
*MAP0889
*MAP0901~0906
*MAP1070
*MAP1111~1120


==Details==
The policies, procedures, and guidelines are published in the production wiki, providing a single resource for all developers:
About #1:
* [https://wikiwiki.jp/yumenikki-g3/%E4%BB%A3%E7%90%86%E5%AE%9F%E8%A3%85/Guidelines Guidelines for Proxy Implementation]
*Do understand that proxy producer has no obligation to implement the content as-is. In an event of submitted update breaking compatibility or breaking any other development guidelines, the proxy update may be cancelled.
* [https://wikiwiki.jp/yumenikki-g3/%E6%B1%BA%E5%AE%9A%E4%BA%8B%E9%A0%85 Basic Rules]
About #2:
*Once again, the production team is under no obligation to apply content of the submissions to the game. Content posted on the loader may be omitted simply because no one of the developers has time to implement it.
*The overseas developer must supply map files with additional text file called "settings.txt". This file should explain setting of 2kki-specific options (example provided below). Changes involving map counting trigger as well track listing in Sound Room will be carried out separately.


===Template for "settings.txt"===
Map creation must be practiced in accordance with these rules and guidelines.
Created by <name>
Twitter: <nowiki>@<twitter></nowiki>
Discord: <handle>#%4d
(at least one communication channel is necessary)
________
Map ID: #
Tileset: <filename>
BGM: <filename>
  [BGM]Fade-in time:
  [BGM]Volume:
  [BGM]Tempo:
Background panorama:
  [BG]Vertical movement: Y/N
  [BG]Horizontal movement: Y/N
  [BG]Scroll speed: %d
Map looping: horizontal/vertical/both/none
Bat warp: Y/N
Penguin slide: Y/N
Tissue is usable: Y/N
Underwater map: Y/N
Entry point: (%d;%d)
Accessed from: MAP ID
Comment:


(repeat for every map in the batch)
In addition, the 2kki Toolkit provides useful information specific to 2kki development:
* [https://docs.google.com/document/d/1_w-N6N3rdjS1BX75Wv24zQShDsI1n6xv-Hia3DBardY/edit?usp=sharing The 2kki Toolkit]


==Contribution Beyond Map Creation==
Contributing to ''Yume 2kki'' is not limited to creating and developing maps. This section lays out ways you can contribute to the game.


Example:
===Asset Repository Submission===
Developed by UROTSUKI
Assets such as art and audio are also provided by the community for developers to make use of. In the [https://wikiwiki.jp/yumenikki-g3/FrontPage/%E3%81%86%EF%BD%90%E3%83%AD%E3%83%80%E7%BE%A4 repository list] of the production wiki's front page, you can find the links to the latest iterations of the asset repositories, where you can contribute audio (referred to as 音楽・効果音優先) or artwork (画像優先).
Twitter:@yumenikki-g3
Discord:RPGmaker#2000
———
MapID : MAP0001
Tileset : UROTSUKI_chip_1.png
BGM : ym2-00_ano deskwork.wav
  [BGM]Fade-in time : 0
  [BGM]Volume: 80%
  [BGM]Tempo: 100
Background panorama : UROTSUKI_panorama_1.png
  [BG]Vertical movement: yes
  [BG]Horizontal movement: no
  [BG]Scroll speed: -2
Map looping: Only vertical
Bat warp: No
Penguin slide: Yes
Tissue is usable: Yes
Underwater map: No
Entry point: (012,180)
Accessed from: MAP0292
Memo : This map cannot use bat effect because it uses screen tint effect.
A common switch is used at (082,097).


==Footnotes==
You may refer to this video as a walkthrough on how to upload assets:
<references />
 
[[Category:Guides]]
<youtube>-0B-2ADKLwg</youtube>
 
When dealing with CAPTCHA here, you can also enable [https://support.microsoft.com/en-us/windows/microsoft-japanese-ime-da40471d-6b91-4042-ae8b-713a96476916 Japanese IME] for keyboard inputs, though this approach presupposes that you can read hiragana.
 
===Collectables===
One can also contribute PC wallpapers or Kura Puzzles that players can collect by fulfilling various conditions. They can be submitted to the artwork repository, or by following the procedures laid out in the [https://discord.gg/7PzspMPqA9 international Yume 2kki Discord server].
 
Note that images in RPG Maker 2000 require being indexed to 256 colors, or a bit depth of 8. Full-screen images like PC wallpapers and dream TV images require that they have a size of 320x240, while Kura Puzzles require a size of 96x96.
 
[[Category:Yume 2kki Guides]]

Latest revision as of 15:19, 7 February 2025

Introduction

The official platform where information regarding Yume 2kki's development is published is the production wiki, also known as the Japanese Yume 2kki development wiki ("ゆめにっきっぽいゲームを作るスレ まとめ Wiki*"). As such, it should be noted that YumeWiki is to be treated as a secondary and derivative resource created and managed by the English-speaking community.

This page aims to help prospective and current developers, particularly within the international community, by signposting the game's official policies, procedures, and guidelines for contribution, especially within the context of proxy implementation. It supersedes the original Content Contribution Guidelines page, preserved for historical purposes.

What is Yume 2kki?

Yume 2kki is a fangame of KIKIYAMA's Yume Nikki, collaboratively developed by enthusiasts of Yume Nikki, inspired by said game. As such, despite the name, it is not a sequel to Yume Nikki. Its development began in 2007 and originated in 2ch, now 5ch, a Japanese anonymous message board, where development is still continuing, primarily by Japanese developers.

The game's premise is to explore an expansive dream world, with no explicit goal given to players, leaving players to decide on how to enjoy the game entirely.

Rationale

With the rise of international contributors to Yume 2kki, which is a Japanese project, it should be clear that smooth collaboration towards its development requires proper communication. To that end, the need for cooperation with non-native English-speaking Japanese developers and communities is highly important, and proxy implementation procedures fulfil that need, in the face of existing language barriers.

The policies, procedures, and guidelines as laid out in the production wiki aim to:

  1. Reduce the burden on Core Developers by defining workflows and scopes for Associate Developers in documenting, preparing, and developing their content,
  2. Bridge the gap in understanding edits between Core and Associate Developers, and
  3. Outline shared information between Core and Associate Developers, where Core Developers serve as proxies to Associate Developers, who request the former to formally implement their content.

Resource Links

The wiki that manages information on Yume 2kki's production projects is ゆめにっきっぽいゲームを作るスレ まとめ Wiki* (the Japanese Yume 2kki development wiki).

In addition, official discussion of the production takes place in the production wiki itself and in threads 避難所 (Shelter) and their 5ch thread.

The policies, procedures, and guidelines are published in the production wiki, providing a single resource for all developers:

Map creation must be practiced in accordance with these rules and guidelines.

In addition, the 2kki Toolkit provides useful information specific to 2kki development:

Contribution Beyond Map Creation

Contributing to Yume 2kki is not limited to creating and developing maps. This section lays out ways you can contribute to the game.

Asset Repository Submission

Assets such as art and audio are also provided by the community for developers to make use of. In the repository list of the production wiki's front page, you can find the links to the latest iterations of the asset repositories, where you can contribute audio (referred to as 音楽・効果音優先) or artwork (画像優先).

You may refer to this video as a walkthrough on how to upload assets:

When dealing with CAPTCHA here, you can also enable Japanese IME for keyboard inputs, though this approach presupposes that you can read hiragana.

Collectables

One can also contribute PC wallpapers or Kura Puzzles that players can collect by fulfilling various conditions. They can be submitted to the artwork repository, or by following the procedures laid out in the international Yume 2kki Discord server.

Note that images in RPG Maker 2000 require being indexed to 256 colors, or a bit depth of 8. Full-screen images like PC wallpapers and dream TV images require that they have a size of 320x240, while Kura Puzzles require a size of 96x96.