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



YumeWiki
3,055Articles

Yume 2kki:Content Contribution Guidelines: Difference between revisions

mNo edit summary
m (this link was a bad idea)
 
(22 intermediate revisions by 12 users not shown)
Line 1: Line 1:
{{MissingInfo|Update list of protected maps.}}
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.
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.


Originally written by 2i9 of the Yume 2kki production team, translated by BSL and +0 Abyss.
Originally written by [[:Category:2i9|2i9]] of the Yume 2kki production team, and translated by BSL and +0 Abyss.


==Preface==
==Preface==
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 massive project, maintaining which 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!
 
Some areas in the game have [[Yume 2kki:Construction Signs#Red Construction Signs|red construction signs]] that mark an open connection to another world. Permission is still needed to connect. Locations with these signs are listed on the Yume 2kki Wiki as [[:Category:Open for Cross-Author Connections|open for cross-author connections]]. There are also locations named [[:Category:Yume 2kki Connecting Maps|connecting maps]] that allow developers to connect ''without'' prior permission. Shared maps such as [[Yume 2kki:The Nexus|The Nexus]] or [[Yume 2kki:Library|Library]] similarly do not require permission.
 
The wiki also lists [[Yume 2kki:switches|switches]], [[Yume 2kki:variables|variables]], and [[Yume 2kki:Common Events|common events]] with a translation of their name and a short description of their function. The reserved [[Yume 2kki:Map IDs|map IDs]] can also be helpful to look at when wanting to connect to existing areas.


==Rules==
==Rules==
Line 19: Line 24:


===Rules Concerning Expression===
===Rules Concerning Expression===
These expressions should not be used when editing maps for Yume 2kki.
These expressions (e.g. content) should not be used when editing maps for Yume 2kki.
*Political expression
*Political expression
*Pornographic expression
*Pornographic expression
Line 28: Line 33:


===Rules for Editing===
===Rules for Editing===
#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.
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.
#Don't create events such as:
 
Don't create events such as:
*Battle Events
*Battle Events
*Events that change Urotsuki's level or parameters
*Events that change Urotsuki's level or parameters


===Six-Month Rule===
===Six-Month Rule===
#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).
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:
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:Wataru|wataru]]'s maps
*[[:Category:Yeris|Yeris]]' maps
*[[:Category:Yeris|Yeris]]' maps
*[[:Category:Anon|Anon]]'s maps (except [[Chaos Exhibition]] (MAP0734))
*The following [[:Category:noildoof|noildoof]]'s maps are protected: [[Yume 2kki:Tesla Garden|Tesla Garden]] (MAP0832~0836), [[Yume 2kki:Doll House|Doll House]] (MAP0837-0838), [[Yume 2kki:Neon Sea|Neon Sea]], including '''Marina's House''' (MAP0840-0841), [[Yume 2kki:Blue Cactus Islands|Blue Cactus Islands]] (MAP0835, MAP842), [[Yume 2kki:Cat Cemetery|Cat Cemetery]] (MAP0843), [[Yume 2kki:Graffiti City|Graffiti City]] (MAP0844), [[Yume 2kki:Misty Bridges|Misty Bridges]] including the '''Lotus Lamp Room''' (MAP0845, MAP0880, MAP0902), [[Yume 2kki:Parasite Laboratory|Parasite Laboratory]] (MAP0877), [[Yume 2kki:Chalkboard Playground|Chalkboard Playground]] (MAP0878, MAP0901), [[Yume 2kki:Ghost Town|Ghost Town]] (MAP0879), [[Yume 2kki:Monochrome Mansion|Monochrome Mansion]] including the '''Monochrome Fields''' (MAP0903-0904), [[Yume 2kki:Dream Venus|Dream Venus]] (MAP0905), [[Yume 2kki:Dream Mars|Dream Mars]] (MAP0906). NOTE: if you want to implement a connection in a map made by noildoof outside of the [[Yume 2kki:Spaceship|Spaceship]], please [[Yume 2kki:Authors#noildoof|contact her]] and only add a connection with her approval (you can also ask if it's possible to add a connection to one of the maps in this list).
*[[:Category:noildoof|noildoof]]'s maps (MAP0832~0838, MAP0840~0845, MAP0854~0855, MAP0877~0880, MAP0901~0906)
*[[:Category:Nantai|Nantai]]'s maps (except [[Yume 2kki:Rainbow Tiles Maze|Rainbow Tiles Maze]] (MAP1102))
*[[:Category:Nantai|Nantai]]'s maps (except [[Rainbow Tiles Maze]] (MAP1102))
*[[Yume 2kki:Minor_Characters#Smile-san_.28Laughing_Man.29|Smile-san]]'s Room (MAP0134)
*[[Minor_Characters#Smile-san_.28Laughing_Man.29|Smile-san]]'s Room (MAP0134)
*[[Yume 2kki:Urotsuki's_Dream_Apartments#Dressing Room|Dressing Room]] & [[Yume 2kki:Fabric World|Fabric World]] (MAP0176)
*[[Urotsuki's_Dream_Apartments#Dressing Room|Dressing Room]] & [[Fabric World]] (MAP0176)
*[[:Category:kuraud|kuraud]]'s Debug Room (MAP0191)
*kuraud's Debug Room (MAP0191)
*[[:Category:shigurin|shigurin]]'s Debug Room (MAP0800)
*shigurin's Debug Room (MAP0800)
*[[Yume 2kki:Monkey Mansion|Monkey Mansion]] (MAP0804, MAP0854), [[Yume 2kki:Chess World|Chess World]] (MAP0855), [[Yume 2kki:Constellation World#Star Building|Star Building]] (MAP0808)
*[[Monkey Mansion]] (MAP0804)
*[[Yume 2kki:Guardians' Temple|Guardians' Temple]] (MAP1070), [[Yume 2kki:Guardians' Temple#Hidden Shrine|Hidden Shrine]] (MAP1111~1120)
*[[Constellation World#Star Building|Star Building]] (MAP0808)
*spelude's maps (except [[Yume 2kki:Coffee Cup World|Coffee Cup World]] (MAP0711), [[Yume 2kki:Tricolor Room|Tricolor Room]] (MAP0692, MAP0716, MAP0717, MAP0963, MAP1396),  [[Yume 2kki:Candy World|Candy World]] (MAP0698),  [[Yume 2kki:Vase World|Vase World]] (MAP0722, MAP0723, MAP0731),  [[Yume 2kki:Neon Candle World|Neon Candle World]] (MAP0730),  [[Yume 2kki:Hand Fields|Hand Fields]] (MAP0726-MAP0727),  [[Yume 2kki:Red Lily Lake|Red Lily Lake]] (MAP0697),  [[Yume 2kki:Honeycomb World|Honeycomb World]] (MAP0691),  [[Yume 2kki:Cloud Tops|Cloud Tops]] (MAP0728),  [[Yume 2kki:Constellation World|Constellation World]] (MAP0699).
*[[Nightmarish Wilds]] (MAP0886~0887, MAP0889)
* [[Yume 2kki:Eyeball Archives|Eyeball Archives]] (MAP0501-MAP0505)
*[[Guardians' Temple]] (MAP1070)
*[[:Category:natl|natl]]'s maps.
*[[Guardians' Temple#Hidden Shrine|Hidden Shrine]] (MAP1111~1120)
*[[Yume 2kki:Rainbow Snow Plateau|Rainbow Snow Plateau]] (MAP2821) as of [[:Category:Stheven|Stheven]]'s request.


==Details==
==Details==
About [[Content Contribution Guidelines#General|#1]]:
About [[Yume 2kki:Content Contribution Guidelines#General|General Rule #1]]:
*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.
*Do understand that a proxy developer 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.
About [[Content Contribution Guidelines#General|#2]]:
 
About [[Yume 2kki:Content Contribution Guidelines#General|General Rule #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.
*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.
*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"===
===Template for "settings.txt"===
Line 85: Line 94:


(repeat for every map in the batch)
(repeat for every map in the batch)


Example:
Example:
Line 116: Line 124:
==Footnotes==
==Footnotes==
<references />
<references />
[[Category:Guides]]
 
[[Category:Yume 2kki Guides]]

Latest revision as of 02:52, 19 December 2024

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.

Originally written by 2i9 of the Yume 2kki production team, and translated by BSL and +0 Abyss.

Preface

Yume 2kki is a massive project, maintaining which 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!

Some areas in the game have red construction signs that mark an open connection to another world. Permission is still needed to connect. Locations with these signs are listed on the Yume 2kki Wiki as open for cross-author connections. There are also locations named connecting maps that allow developers to connect without prior permission. Shared maps such as The Nexus or Library similarly do not require permission.

The wiki also lists switches, variables, and common events with a translation of their name and a short description of their function. The reserved map IDs can also be helpful to look at when wanting to connect to existing areas.

Rules

General

In order for overseas[1] developers to join the production of Yume 2kki, either of these rules must be followed:

  1. 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.
  2. The compiled maps, graphics, sounds and BGM are uploaded onto the game's content repository[2] (aka, "loader"). From there, an active producer may volunteer to implement the content in the game.

Furthermore, these policies must be observed:

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

These expressions (e.g. content) should not be used when editing maps for Yume 2kki.

  • Political expression
  • 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

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.

Don't create events such as:

  • Battle Events
  • Events that change Urotsuki's level or parameters

Six-Month Rule

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:

Details

About General Rule #1:

  • Do understand that a proxy developer 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.

About General Rule #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"

Created by <name>
Twitter: @<twitter>
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)

Example:

Developed by UROTSUKI
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

  1. "overseas" in this context means any country that isn't Japan.
  2. See this page for details on game's repositories.