-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathabout-rustmania.html
More file actions
32 lines (23 loc) · 2.93 KB
/
Copy pathabout-rustmania.html
File metadata and controls
32 lines (23 loc) · 2.93 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
<!DOCTYPE HTML>
<html>
<head>
<link href="styles/style.css" rel="stylesheet" type="text/css">
<title>About RustMania</title>
</head>
<body>
<header><h2>About RustMania</h2></header>
<p>We are making a rhythm game with custom songs, noteskins, and themes!</p>
<p>The game will load each type of content from its own dedicated folder. By default these will be in a subfolder of the main install location, titled <b>Songs</b>, <b>Noteskins</b>, and <b>Themes</b> respectively.</p>
<h3>Songs</h3>
<p>Within the songs folder, each song should have its own subfolder. Each subfolder should contain: <ul><li>The music file, in either .mp3, .ogg, or .wav format</li> <li>Either a .rm or a .sm file that dictates the structure of the notes to be hit</li> <li>Any other resources you wish to use</li></ul> We currently do not have support for background images or videos, and we also do not display song banners, but this is planned for the future.</p>
<h3>Noteskins</h3>
<p>In the Noteskins folder, each noteskin should have its own subfolder. In each subfolder there should be: <ul><li>A .toml file, this file should contain:<ul><li>The location of an image file for each part of the noteskin</li><li>A line for each aspect of the noteskin you wish to vary from default.</li></ul></li><li>Any resources specified within your .toml.</li></ul>While we aim not to break backward compatibilty, it is early in development and the format may change before final release.</p>
<h3>Themes</h3>
<p>The theming capabilities of RustMania are currenly in their very early stages, so the format for a theme is currently not set. So we omit a detailed description of the format, and instead outline the plan for themes going forward.</p>
<p>A theme will consist of a list of <b>Screens</b>, these screens will themselves consist of a list of <b>Elements</b>, and these elements determine what will be displayed on the screen. Here is a list of currently implemented Elements:
<ul><li>Notefield</li><li>Music</li></ul>
And here are some elements that are currently being planned:
<ul><li>Text Box</li><li>Image</li><li>Element List</li></ul>The number of elements is likely to expand considerably as the capabilities of RustMania grow. We will keep this list updated whenever new Elements are added.</p>
<p>To allow variation between Elements of the same type, most types of Elements accept one or more <b>Resoureces</b>. A Resource is a piece of data that is specified by a theme, the exact value of this data can be changed based on the Resource's associated script. Resoureces can be divided into two types: <dl><di>Screen Resoureces</di> <dd>Resources that are only available to the current screen</dd><di>Global Resoureces</di> <dd>Resources that are available to all screens, but that can only be changed when going between screens</dd></dl> The exact details of the Resource system are currently a work in progress, so we do not currently have a list of Resource types available.</p>
</body>
</html>