How to contribute: Difference between revisions

From DDraceNetwork
← Older edit
VisualWikitext
mNo edit summary
 
(26 intermediate revisions by 9 users not shown)
Line 1: Line 1:
== What to contribute? ==
<languages />
 
<translate>
<!--T:1-->
We welcome you to contribute to this wiki. Feel free to edit any pages to improve this wiki. All changes made in good faith are welcome. [[wikipedia:Wikipedia:Be_bold|Be bold!]] When you are unsure about something, you can always ask in the #wiki channel on [https://ddnet.org/discord Discord] or [https://matrix.to/#/#ddnet-wiki:matrix.org Matrix]. This page should help getting started to contribute. You need to register in order to contribute.
 
==What to contribute?== <!--T:2-->
 
<!--T:3-->
We encourage every kind of contribution. Here are a few examples what you could do:
We encourage every kind of contribution. Here are a few examples what you could do:


* You can always fix problems, correct grammar, make sure wording is accurate, etc. (See Editing Pages)
<!--T:4-->
* Expand an article by covering another topic
*You can always fix problems you see, correct grammar, make sure wording is accurate, etc.
* Create videos for articles ([[#How_to_create_a_video|How to create videos]])
*Expand an article by covering another topic
* Write a new article. A variety of topics are yet to be covered
*Create videos for articles ([[Special:MyLanguage/How to contribute#how_to_create_a_video|How to create videos]])
* Here you can find articles that need content: [[:Category:Needs Content]]
*Write a new article. A variety of topics are yet to be covered
*Here you can find articles that need content: [[:Category:Needs Content|Category:Needs Content]]
 
==What content is accepted?== <!--T:5-->
 
<!--T:6-->
Articles should be related to the DDNet and Teeworlds community/projects/ecosystem.
 
<!--T:7-->
Please do not put "Made by X" or "Wiki Article by X" when writing an article, authorship is seen by contributions that can be looked up on "View History", not at the article directly.
 
<!--T:60-->
Please do not edit other User personal pages, those look like <code>User:Username</code>.


== Moderation ==
==Moderation== <!--T:8-->
 
<!--T:9-->
Changes made to the wiki go to a moderation queue, where moderators will check if the change you made is vandalism.
Changes made to the wiki go to a moderation queue, where moderators will check if the change you made is vandalism.


<!--T:10-->
Here are our practices we follow when moderating content, which the extension itself recommends:
Here are our practices we follow when moderating content, which the extension itself recommends:


=== Recommended use / good practices when moderating ===
===Recommended use / good practices for moderators=== <!--T:11-->
 
<!--T:12-->
The following good-practices are advised:
The following good-practices are advised:


# Only vandalism should be Rejected. Not-so-good edits with good intentions (e.g. adding excessive plot details into the Wikipedia article about film) are better made Approved and then reverted as usual. This way the author is not offended and the text is saved in page history, viewable by anyone.
<!--T:13-->
# Any user that is deemed legitimate (does N good edits) should be added into <code>automoderated</code> group.
#Only vandalism should be Rejected. Not-so-good edits with good intentions (e.g. adding excessive plot details into the Wikipedia article about film) are better made Approved and then reverted as usual. This way the author is not offended and the text is saved in page history, viewable by anyone.
# Adding users to <code>automoderated</code> group via <code>$wgAutopromote</code> is NOT recommended, as it motivates the vandals to do many very-minor edits (e.g. adding interwiki). Better promote them to <code>automoderated</code> manually for one good edit and not promote for 30 useless-edits-made-for-count.
#Any user that is deemed legitimate (does N good edits) should be added into <code>automoderated</code> group.
# Abstain from using blocks. Don't protect pages "just in case", except maybe for important templates.
#Adding users to <code>automoderated</code> group via <code>$wgAutopromote</code> is NOT recommended, as it motivates the vandals to do many very-minor edits (e.g. adding interwiki). Better promote them to <code>automoderated</code> manually for one good edit and not promote for 30 useless-edits-made-for-count.
# Allow the full rehabilitation of users with a bad history of editing. Their useful edits to the articles should be allowed, no matter how many times they were blocked. At the same time, trolling on talk pages should be rejected, so are the purposely-low-quality edits.
#Abstain from using blocks. Don't protect pages "just in case", except maybe for important templates.
#Allow the full rehabilitation of users with a bad history of editing. Their useful edits to the articles should be allowed, no matter how many times they were blocked. At the same time, trolling on talk pages should be rejected, so are the purposely-low-quality edits.
 
==How to create a video== <!--T:14-->


== How to create a video ==
===Step 1: Getting a Map=== <!--T:15-->
(TODO: Update this section to be usable on the new wiki)


=== Step 1: Getting a Map ===
====Variant 1: Using an existing map==== <!--T:16-->


==== Variant 1: Using an existing map ====
<!--T:17-->
To use maps from videos in the wiki:
To use maps from videos in the wiki:


# Right-click the video and click ‘View Video’, now you can find the name of the video in the URL
<!--T:18-->
# Go here and download the correct demo
#Right-click the video and click ‘Open Video in New Tab’. Now you can find the name of the video in the URL
# Open the demo in your client (you need to move the demo into your <code>data/maps</code> folder)
#Go [https://gitlab.com/ddnet-wiki/ddnet-wiki.gitlab.io/-/tree/master/static/videos here] and download the correct demo
# While you have the demo open, go into the editor, click <code>File</code>, and select <code>Load Current Map</code>
#Open the demo in your client (you need to move the demo into your <code>data/demos</code> folder)
#While you have the demo open, go into the editor, click <code>File</code>, and select <code>Load Current Map</code>


<!--T:19-->
Now you can edit and use the map for the demo.
Now you can edit and use the map for the demo.


==== Variant 2: Creating a new map ====
====Variant 2: Creating a new map==== <!--T:20-->
 
<!--T:21-->
#Create a new map in the editor
#Set the background color to <code>#5E84AEFF</code>
##Click on the <code>quads</code> layer
##Right-click the corners of the rectangle
##Insert the color value <code>#5E84AEFF</code> into the third to last field each each
#The main focus should be that it is comprehensible
#Keep the style simple and similar to the other videos
#*Use simple textures (preferably <code>grass_main</code>, combined with <code>generic_unhookable</code> and <code>font_teeworlds</code>)
#*Make it loopable, you can get creative with that :)
#*Insert a scale if suited


# Create a new map in the editor
====Step 2.1: Recording the demo==== <!--T:22-->
# Set the background color to <code>#5E84AE</code>
## Click on the <code>quads</code> layer
## Right-click the corners of the rectangle
## Insert the color value <code>#5E84AE</code> into the third to last field each each
# The main focus should be that it is comprehensible
# Keep the style simple and similar to the other videos
#* Use simple textures (preferably <code>grass_main</code>, combined with <code>generic_unhookable</code> and <code>font_teeworlds</code>)
#* Make it loopable, you can get creative with that :)
#* Insert a scale if suited


=== Step 2.1: Recording the demo ===
<!--T:23-->
#Turn demo recording on
#*I suggest <code>Settings -> General -> Automatically record demos</code>
#Load the map on a server
#*Start your own DDNet server or use the [https://trashmap.ddnet.org/ Trashmap] hosting service
#Join it with your client, try the trick until you are satisfied with the result and keep loopability in mind


# Turn demo recording on
====Recording Settings==== <!--T:24-->
#* I suggest <code>Settings -> General -> Automatically record demos</code>
# Load the map on a server
#* Start your own DDNet server or use the [https://trashmap.timakro.de/ Trashmap] hosting service
# Join it with your client, try the trick until you are satisfied with the result and keep loopability in mind


=== Recording Settings ===
<!--T:25-->
Set consistent skin:
Set consistent skin:


* Hammer: brownbear
<!--T:26-->
* Pistol: coala
*Hammer: brownbear
* Shotgun: cammo
*Pistol: coala
* Grenade: redstripe
*Shotgun: cammo
* Laser: bluestripe
*Grenade: redstripe
* Hook: default
*Laser: bluestripe
* Jump: bluekitty
*Hook: default
*Jump: bluekitty


=== Step 2.2: Cutting the demo ===
====Step 2.2: Cutting the demo==== <!--T:27-->


# In your client, go to <code>Demos -> auto/</code>
<!--T:28-->
# Open the demo you recorded
#In your client, go to <code>Demos -> auto/</code>
#* Tip: Click on <code>Date</code> to sort by date
#Open the demo you recorded
# Press <code>Escape</code> for demo functions
#*Tip: Click on <code>Date</code> to sort by date
# Use the 2 buttons on the left of the camera icons to select a starting and end point
#Press <code>Escape</code> for demo functions
# Use the camera icon to save the shortened demo
#Use the 2 buttons on the left of the camera icons to select a starting and end point
#Use the camera icon to save the shortened demo


<!--T:29-->
Tip: you can repeat these steps multiple times to be able to cut the demo more precisely
Tip: you can repeat these steps multiple times to be able to cut the demo more precisely


=== Converting the demo ===
====Step 2.3: Converting the demo to a video==== <!--T:30-->
 
<!--T:31-->
Once you have the client, converting a demo is as simple as:
Once you have the client, converting a demo is as simple as:


* Open the client (with the converting functionality)
<!--T:32-->
* Set zoom to 10: <code>cl_default_zoom 10</code>
*Open the client (with the converting functionality)
* Go to the <code>Demos</code> tab
*Set zoom to 10: <code>cl_default_zoom 10</code>
* Select the correct demo
*Go to the <code>Demos</code> tab
* Click <code>Render</code> at the bottom
*Select the correct demo
*Click <code>Render</code> at the bottom
 
===Step 3: Getting the video into the wiki=== <!--T:33-->
 
<!--T:34-->
Some of the following steps might be a little overwhelming. You can simply ask one of the wiki admins to do the remaining steps.
 
====Step 3.1: Cropping the video==== <!--T:35-->
 
<!--T:36-->
Using your preferred video editor, crop the video, so that only the relevant cutout of the video remains. You can look at other videos from the wiki to get a feel for how much you should crop.
 
====Step 3.2: Uploading the video to the wiki==== <!--T:37-->
 
<!--T:38-->
To upload a video to the wiki first you need permissions, if you are considered a trustworthy contributor you will get them, if you consider yourself trustworthy you can ask an administrator to consider giving you the permission to upload files.
 
<!--T:39-->
To upload a file you can go to [[Special:Upload|Upload file]] link on the sidebar.
 
====Step 3.3: Inserting the video into an article==== <!--T:40-->
 
<!--T:41-->
To insert a video into an article, first you have to choose whether it fits in the text or on a side.
 
<!--T:42-->
Usually, if the text mentions some steps to take or the video is directly related to a text, it's better to put it there like this:


=== Step 4: Cropping the video ===
<!--T:43-->
Now that we have our video, we will now want to crop it down, so that only the relevant area of it is shown. For this exact process we have created the <code>crop.sh</code> script. You can find it in <code>/scripts/crop.sh</code>.
<nowiki>[[File:myvideo.mp4|gif]]</nowiki>


To use it:
<!--T:44-->
If you consider it better to be floating on the right side, you can do this


# First '''edit the <code>crop.sh</code> script to set the <code>PIXEL_PER_TILE</code> value correctly!'''
<!--T:45-->
# Use it as a commandline tool:
<nowiki>[[File:myvideo.mp4|right|gif]]</nowiki>
#* The first argument is the input video file
#* The second argument is the output video file
#* The third to sixth arguments are each, how many tiles upwards/downwards/to the left/to the right should be seen in the video
# Try different settings to get the best result
# Remember to '''include the exact command you used in the commit message, as well as your <code>PIXEL_PER_TILE</code> value'''!


=== Step 5: Creating a merge request for the repository ===
<!--T:46-->
You don’t have to be familiar with git to create a merge request:
Or with a thumb and a label:


# Go to the folder view
<!--T:47-->
# Click on the drop-down menu next to the <code>videos</code> folder
<nowiki>[[File:myvideo.mp4|thumb|This video shows this!|gif]]</nowiki>
# Click <code>Upload file</code>
# Upload all relevant files this way, for each video include the .demo
# Click on the blue button <code>Commit...</code>
# Write into the ‘Commit Message’ what you are changing (e.g. which video you are adding)
# Insert the crop command(s) you used from step 4!
# Create a new branch; it should be selected by default, if not, tick it
# Press the green button ‘Commit’


=== Step 6: Insert videos in pages ===
<!--T:48-->
See About for how to edit pages. Adding <nowiki>{{% vid vid-name %}}</nowiki> to markdown pages includes <code>/video/vid-name.mp4</code> in the HTML page.
If you think the video is too small, you can specify a size:


== Templates ==
<!--T:49-->
<nowiki>[[File:myvideo.mp4|gif|400px]]</nowiki>
 
<!--T:50-->
You can learn more in detail about media placement here: https://www.mediawiki.org/wiki/Help:Images
 
==Templates== <!--T:51-->
 
<!--T:52-->
If you identify a common occurrence, such as weapon info boxes, you can automate it creating templates, more info [[mediawikiwiki:Help:Templates|here]].
If you identify a common occurrence, such as weapon info boxes, you can automate it creating templates, more info [[mediawikiwiki:Help:Templates|here]].


<!--T:53-->
List of created templates:
List of created templates:


<!--T:54-->
[[:Category:Templates|Category:Templates]]
[[:Category:Templates|Category:Templates]]
==Translation== <!--T:55-->
===Title=== <!--T:56-->
<!--T:57-->
To translate the title you can go to "Edit source" and add <code><nowiki>{{DISPLAYTITLE:Translated title}}</nowiki></code>  to the top of the page replacing "Translated title" with the title you want displayed.
===Linking=== <!--T:58-->
<!--T:59-->
You can achieve the same in the visual editor, by first linking the translated page: e.g. by typing <code><nowiki>[[</nowiki></code> to open the linking page. Enter <code>Jump/de</code> (replacing <code>de</code> with the target language code) to link to the correct page and then modify the display text to the translated version.
</translate>

Latest revision as of 22:32, 25 October 2024

Other languages:

We welcome you to contribute to this wiki. Feel free to edit any pages to improve this wiki. All changes made in good faith are welcome. Be bold! When you are unsure about something, you can always ask in the #wiki channel on Discord or Matrix. This page should help getting started to contribute. You need to register in order to contribute.

What to contribute?

We encourage every kind of contribution. Here are a few examples what you could do:

  • You can always fix problems you see, correct grammar, make sure wording is accurate, etc.
  • Expand an article by covering another topic
  • Create videos for articles (How to create videos)
  • Write a new article. A variety of topics are yet to be covered
  • Here you can find articles that need content: Category:Needs Content

What content is accepted?

Articles should be related to the DDNet and Teeworlds community/projects/ecosystem.

Please do not put "Made by X" or "Wiki Article by X" when writing an article, authorship is seen by contributions that can be looked up on "View History", not at the article directly.

Please do not edit other User personal pages, those look like User:Username.

Moderation

Changes made to the wiki go to a moderation queue, where moderators will check if the change you made is vandalism.

Here are our practices we follow when moderating content, which the extension itself recommends:

Recommended use / good practices for moderators

The following good-practices are advised:

  1. Only vandalism should be Rejected. Not-so-good edits with good intentions (e.g. adding excessive plot details into the Wikipedia article about film) are better made Approved and then reverted as usual. This way the author is not offended and the text is saved in page history, viewable by anyone.
  2. Any user that is deemed legitimate (does N good edits) should be added into automoderated group.
  3. Adding users to automoderated group via $wgAutopromote is NOT recommended, as it motivates the vandals to do many very-minor edits (e.g. adding interwiki). Better promote them to automoderated manually for one good edit and not promote for 30 useless-edits-made-for-count.
  4. Abstain from using blocks. Don't protect pages "just in case", except maybe for important templates.
  5. Allow the full rehabilitation of users with a bad history of editing. Their useful edits to the articles should be allowed, no matter how many times they were blocked. At the same time, trolling on talk pages should be rejected, so are the purposely-low-quality edits.

How to create a video

Step 1: Getting a Map

Variant 1: Using an existing map

To use maps from videos in the wiki:

  1. Right-click the video and click ‘Open Video in New Tab’. Now you can find the name of the video in the URL
  2. Go here and download the correct demo
  3. Open the demo in your client (you need to move the demo into your data/demos folder)
  4. While you have the demo open, go into the editor, click File, and select Load Current Map

Now you can edit and use the map for the demo.

Variant 2: Creating a new map

  1. Create a new map in the editor
  2. Set the background color to #5E84AEFF
    1. Click on the quads layer
    2. Right-click the corners of the rectangle
    3. Insert the color value #5E84AEFF into the third to last field each each
  3. The main focus should be that it is comprehensible
  4. Keep the style simple and similar to the other videos
    • Use simple textures (preferably grass_main, combined with generic_unhookable and font_teeworlds)
    • Make it loopable, you can get creative with that :)
    • Insert a scale if suited

Step 2.1: Recording the demo

  1. Turn demo recording on
    • I suggest Settings -> General -> Automatically record demos
  2. Load the map on a server
    • Start your own DDNet server or use the Trashmap hosting service
  3. Join it with your client, try the trick until you are satisfied with the result and keep loopability in mind

Recording Settings

Set consistent skin:

  • Hammer: brownbear
  • Pistol: coala
  • Shotgun: cammo
  • Grenade: redstripe
  • Laser: bluestripe
  • Hook: default
  • Jump: bluekitty

Step 2.2: Cutting the demo

  1. In your client, go to Demos -> auto/
  2. Open the demo you recorded
    • Tip: Click on Date to sort by date
  3. Press Escape for demo functions
  4. Use the 2 buttons on the left of the camera icons to select a starting and end point
  5. Use the camera icon to save the shortened demo

Tip: you can repeat these steps multiple times to be able to cut the demo more precisely

Step 2.3: Converting the demo to a video

Once you have the client, converting a demo is as simple as:

  • Open the client (with the converting functionality)
  • Set zoom to 10: cl_default_zoom 10
  • Go to the Demos tab
  • Select the correct demo
  • Click Render at the bottom

Step 3: Getting the video into the wiki

Some of the following steps might be a little overwhelming. You can simply ask one of the wiki admins to do the remaining steps.

Step 3.1: Cropping the video

Using your preferred video editor, crop the video, so that only the relevant cutout of the video remains. You can look at other videos from the wiki to get a feel for how much you should crop.

Step 3.2: Uploading the video to the wiki

To upload a video to the wiki first you need permissions, if you are considered a trustworthy contributor you will get them, if you consider yourself trustworthy you can ask an administrator to consider giving you the permission to upload files.

To upload a file you can go to Upload file link on the sidebar.

Step 3.3: Inserting the video into an article

To insert a video into an article, first you have to choose whether it fits in the text or on a side.

Usually, if the text mentions some steps to take or the video is directly related to a text, it's better to put it there like this:

[[File:myvideo.mp4|gif]]

If you consider it better to be floating on the right side, you can do this

[[File:myvideo.mp4|right|gif]]

Or with a thumb and a label:

[[File:myvideo.mp4|thumb|This video shows this!|gif]]

If you think the video is too small, you can specify a size:

[[File:myvideo.mp4|gif|400px]]

You can learn more in detail about media placement here: https://www.mediawiki.org/wiki/Help:Images

Templates

If you identify a common occurrence, such as weapon info boxes, you can automate it creating templates, more info here.

List of created templates:

Category:Templates

Translation

Title

To translate the title you can go to "Edit source" and add {{DISPLAYTITLE:Translated title}} to the top of the page replacing "Translated title" with the title you want displayed.

Linking

You can achieve the same in the visual editor, by first linking the translated page: e.g. by typing [[ to open the linking page. Enter Jump/de (replacing de with the target language code) to link to the correct page and then modify the display text to the translated version.

Retrieved from "https://wiki.ddnet.org/index.php?title=How_to_contribute&oldid=36934"