-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[wiki] Update page about inclusion standard.
Signed-off-by: Johannes <johannesschneider@outlook.com>
- Loading branch information
1 parent
0d759cd
commit 4932676
Showing
1 changed file
with
31 additions
and
66 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,72 +1,37 @@ | ||
| # Inclusion standard | ||
|
|
||
| # Inclusion Standard | ||
| If you want to contribute content to Inexor, make sure to follow these rules: | ||
|
|
||
| You disagree with something written on this page? Let us know here: https://github.com/inexorgame/inexor-core/issues/270 | ||
| ## Licenses (important) | ||
| * Inexor is an 100% open source project! This includes the source code but also the media assets. | ||
| * You must submit your content under an open source license which is accepted by us. | ||
| * You must assign a license to your work. "Do whatever you want with it" is not a license. | ||
| * Check our [list of accepted licenses](../License-Policy.md). | ||
| * If you can't decide which license to use, choose [CC0 BY 4.0](https://creativecommons.org/licenses/by/4.0/deed.en). | ||
| * If you disagree with open source licenses, you cannot contribute to Inexor. | ||
| * If no license is provided, your content will be deleted. | ||
| * In case you uploaded the work of someone else but it does not have an open source license, the content will be deleted. | ||
|
|
||
| *** | ||
| ## Git for version control | ||
| * Inexor uses [Git version control system](https://git-scm.com/). | ||
| * If you are new to Git, try [Github Desktop](https://desktop.github.com/). It's easy to use. | ||
|
|
||
| ## General | ||
| * Keep source files, like .flac, .blend, .xcf and so on. If you, we or anybody else want one day to edit our content these files are essential | ||
| * All file names should be lower case | ||
| ## Security | ||
| * For media assets like models, textures or sounds, [signing commits](https://git-scm.com/book/en/v2/Git-Tools-Signing-Your-Work) is not required. | ||
| * If you want to contribute code, the commits must be [signed](https://git-scm.com/book/en/v2/Git-Tools-Signing-Your-Work) for cryptographic security. | ||
|
|
||
| ## Sounds & Music | ||
| * Use Flac for recoding | ||
| * Use .ogg vorbis for inclusion ingame | ||
| * No lyrics in background music | ||
|
|
||
| ## Textures: | ||
| * Use .png or .webp | ||
| * Textures should be at least 512x512px, , exceptions are possible, highly preferable is 1024x1024 | ||
|
|
||
|
|
||
| ## Models | ||
| * Use .iqm or .obj (exceptions possible for md5 in rare cases) | ||
|
|
||
| <!--Skyboxes (TODO)--> | ||
|
|
||
|
|
||
| ## Maps | ||
|
|
||
| Every map **requires** to have a | ||
| * .txt (readme with license information), | ||
| * .cfg (config), | ||
| * .wpt (waypoints), | ||
| * .ogz (map itself) | ||
| * and a .png preview file. | ||
|
|
||
| The following are basic guidelines to follow if you want a map included in the offical release of Inexor. We recommand highly to use this also as a reference if you just want to build a map and publish it in another way. | ||
|
|
||
|
|
||
| ### 1. Optimized grid size | ||
| Most important, the map should be built correctly. This includes using large grid sizes as often as possible and building nicely within these large gridsizes. Building a map the right way can not only reduce the file size and load time, but most importantly will prevent unnecessary amounts of lag while playing your map. To more understand this concept, check out this video on map optimization: http://youtu.be/clWyKy5eRnQ | ||
|
|
||
| ### 2. Navigation and flow | ||
| Stick to the game mode you want the map to be for. For example: a crazy maze-like layout might be nice for capture, but horrible for CTF; skip the flags if your map is for anything but CTF. Insta maps are best when pretty open and not too much clutter, FFA maps are usually a bit more complex. Keep in mind that no one wants to get lost while trying to play your map. It should be enjoyable 100 percent, so avoid things like dead ends if they don't fit the game mode, confusing hallways, anything that is a distraction from the fun of the game. If you are going to make a super complex layout, make sure it flows nicely, and have some landmarks to make the layout easier to remember after only a few times playing it. Maps where every wall and room look exactly the same are not only boring but also hard to stay oriented in. Keep the navigating of your map as simple as possible. | ||
|
|
||
| The gameplay of Inexor is very fast, so you don't want that players are stucking everywhere and get slow down in a normally hectic round. Build rooms, doors and other ceilings high enough. Players who perform a basic jump of the ground should never touch the ceiling. | ||
|
|
||
|
|
||
| ### 3. Sophisticated placing | ||
| Create waypoints and drop well placed pick-ups. Placing ammo pickups, armor, and health is an art form in itself. Really pay attention to where you place them and how they could affect the gameplay. Even if your map will never be played with bots, or on a mode that uses items, it is good to have them on the occasion that they are. | ||
|
|
||
| Don't be irrational. Don't place death, clips or similar stuff at places, where players can't see visual anything. Also, for example, clean water which kills is not logical either. | ||
|
|
||
| ### 4. Lighting | ||
| Use appropriate lighting. We've all seen maps which are so dark you can barely see the walls and details, and maps which are so bright you can't even see your own cross hair. Remember that the main goal of a playable map is to appeal to your audience in every way possible. Players expect nothing short of the best experience while playing a map, after all that's what gaming is all about. Even one small distraction like improper lighting can deem your map completely unplayable. Even if your map has an great layout. | ||
|
|
||
| ### 5. Minimalist | ||
| Avoid spamming particles, textures, and map models. Particles are a nice touch to some maps, but they can also be very distracting and lazy when spammed too much. They also have a tendency to cause FPS drops on lower end systems. Not to mention it looks pretty cheap when the focus of your map is the amount of particle spam. To go along with that, unless your map includes buildings made of bricks, spamming the same texture everywhere in your map also can be pretty bad. When every wall looks the same, it can be very confusing for a player trying to learn your map. Map models should also be used sparingly, and should not be the thing that makes your map. If it looks awesome until you do a /mapmodelreset, try cutting down on the map models. | ||
|
|
||
| ### 6. Create originals | ||
| Focus on uniqueness. No one wants to play the same theme over and over with slightly different layouts. Try to come up with an awesome idea or theme before you even start your map, something that hasn't been done before. Anything is possible, and you don't need to follow the template of maps before you, just make anything that comes to mind and the gameplay and layout will come naturally. You will be surprised with the possibilities creating completely original content allows. | ||
|
|
||
| ### 7. Sounds & Music | ||
| Don't underestimate the effect of sounds! If you chose the false ones, your complete environment will be unauthentic. On the other hand, if you choose the right sounds it really uplifts the experience of your map. | ||
|
|
||
| ### 8. Map names | ||
| Don't use upper cases or hypens. Stick to non-special-characters and underscores. | ||
|
|
||
| ### 9. Be motivated! | ||
| Put in the work and time. Remember that a good map is a piece of art, so spend some time on it! Do your homework and take a look at your map from an outsider's view point. Is it really a good map? Take pride in your work and consider every one a masterpiece. Even when you think you are finally done, let it sit for a while after you think you've finished, and you might be surprised when you come back to it and notice things you missed the first time through. | ||
|
|
||
| Good luck and have fun creating maps! | ||
| * Contribute models to Inexor's model repository. | ||
| * Use [glTF2](https://www.khronos.org/gltf/) file format. | ||
| * Don't use obj, md3/md5 or iqm. Inexor does not support this! | ||
|
|
||
| ## Textures | ||
| * Use [jpg](https://en.wikipedia.org/wiki/JPEG) or [png](https://en.wikipedia.org/wiki/Portable_Network_Graphics) as file format. | ||
| * Textures must have a resolution of base 2, at least 512x512px, highly preferable is 1024x1024. | ||
| * Please notice that popular texture websites forbit to use their textures in open source projects. | ||
|
|
||
| ## Sound/Music | ||
| * Use [flac](https://en.wikipedia.org/wiki/FLAC) for recoding audio, but prefer [ogg vorbis](https://en.wikipedia.org/wiki/Ogg) for inclusion ingame later. | ||
| * No lyrics in background music. | ||
| * All file names should be lower case (numbers and underscores allowed). | ||
| * Keep source files, like .flac, .blend, .xcf and so on. If you, we or anybody else want one day to edit our content these files are essential. |