wiremod/wire
1
0
Fork 0
mirror of https://github.com/wiremod/wire.git synced 2025-03-04 03:03:04 -05:00
Code Issues Packages Projects Releases Wiki Activity
Page: Misc: Wiki Contribution Guide
Pages
Creating an E2 Core Developer Style Guide Developer: E2 Checklist E2 Guide: EGP Basics E2 Guide: File Extension E2 Guide: Lambda Timers E2 Guide: Lambdas E2 Guide: Ops E2: Chat Commands E2: EGP Objects E2: EGP E2: Find Functions E2: Learning and getting help E2: Physics E2: Tips and Tricks E2: Triggers Expression 2 Core Expression 2 Directives Expression 2 Editor Expression 2 Events Expression 2 Self Aware Expression 2 Syntax Expression 2 Gates Angle Gates Arithmetic Gates Array Gates Bitwise Gates Comparison Gates Entity Gates Logic Gates Memory Home Legacy Guides & Expression 2 Tooling Misc: Wiki Contribution Guide Prop core Quaternions Guide by Fizyk Tool: Cam Controller Tool: Freezer Tool: Gates Tool: Prop Spawner Tool: Turret Tool: User Tool: Wiring Tool: ZCPU Tool: ZGPU Tools Wire Map Interface Wiremod Folder Structure e2 docs angle e2 docs array e2 docs bitwise e2 docs bone e2 docs chat e2 docs color e2 docs compat e2 docs complex e2 docs console e2 docs constraint e2 docs core e2 docs custom camera e2 docs custom constraintcore e2 docs custom effects e2 docs custom ftrace e2 docs custom holoanim e2 docs custom light e2 docs custom prop e2 docs custom remoteupload e2 docs custom stcontrol e2 docs custom tracesystem e2 docs custom wiring e2 docs datasignal e2 docs debug e2 docs egpfunctions e2 docs entity e2 docs files e2 docs find e2 docs globalvars e2 docs hologram e2 docs http e2 docs matrix e2 docs npc e2 docs number e2 docs player e2 docs quaternion e2 docs ranger e2 docs selfaware e2 docs serialization e2 docs serverinfo e2 docs signal e2 docs sound e2 docs string e2 docs table e2 docs timer e2 docs toc e2 docs unitconv e2 docs vector e2 docs vector2 e2 docs weapon e2 docs wirelink
0 Misc: Wiki Contribution Guide
Denneisk edited this page 2024-12-03 17:33:53 +00:00
Table of Contents

For the most part, articles can be written however the writer chooses, as long as it follows the code of conduct and this guide.

Home/index/landing pages can ignore most of these rules, such as Expression 2.

We consider two types of regular articles on the wiki, Documentation and Guide articles.

Documentation articles pertain to documenting how a certain part of Wiremod is used and is meant to be concrete, informative, and neutral. A documentation article can have examples but should not focus on complex examples. Documentation articles can have preambles explaining theory, usage, and other relevant information. Documentation articles should generally be limited to a single focus, such as a single E2 extension, gate category, or tool.

Guide articles pertain to instructing the reader on how to perform a task or use a feature in Wiremod and can be more personalized to the writer's style. A guide article can describe various Wiremod features but should not be overly technical. Guides can be broad but not random. Consider enhancing a preexisting guide instead of creating a new one if the subjects are similar.

Titles

Titles should be labeled by the relevant category it belongs to, separated by a colon and space. Guide articles should have Guide added after the category, such as E2 Guide:. Misc guides are exempt from this, but can do so anyway. An Expression 2 article should be labeled E2:. A gate article should be labeled Gate:. A tool article should be labeled Tool:. Articles for developers should be labeled Dev:. Any other article should be labeled Misc:.

Linking

Please link to your article from another page once you have finished writing it. This helps other people find it much easier. Generally you should do this in the index page for the category and/or sidebar. Do not link directly from unrelated categories. Misc articles are exempt but encouraged to link if reasonable. When linking, use the name of the article as the anchor text and only include the path to the article, such as [Expression 2](/wiremod/wire/wiki/Expression-2).

Sample code

Sample (example) code should follow best E2 practices and refrain from including deprecated features, unless there is good reason. Sample code should use syntax highlighting. There is no perfect language for syntax highlighting, but we recommend golo, ts, and ruby. You are free to use any language you find fit, however.

function myFunction(MyVar:string) { print("Hello " + MyVar) } # prints 'Hello' followed by MyVar, golo

function myFunction(MyVar:string) { print("Hello " + MyVar) } # prints 'Hello' followed by MyVar, ts

function myFunction(MyVar:string) { print("Hello " + MyVar) } # prints 'Hello' followed by MyVar, ruby

Difficulty

Difficulty should be assigned to guides to represent the expected experience level of the reader. Difficulty is difficult to gauge objectively, so the following lists provides terse examples to help visualize the skill required. Difficulty should be represented using the same icons for consistency.

  • 🔰 Beginner - "Hello World" Introduces the reader to a single concept/feature of Wiremod/E2 that is foundational to using it.
  • 🟢 Easy - "Simple Cars" Presents simple concepts that should be easy after learning the syntax/usage.
  • 🟨 Intermediate - "Automated Turrets" Combines previous knowledge to make a more complex example.
  • 🔶 Advanced - "Computers" Uses advanced logic, math, or ideas that less experienced users may be uncomfortable with.
  • 🔺 Expert - "AI Robot" Covers concepts that are only relevant to advanced users.

Expression 2 ⚙️

Getting Started 🕊

Guides (In learning order) 🎓

Tools 🛠️

Click To Expand

Advanced

Beacon 💡

Control 🎛️

Data 💿

Detection 👀

Display 💻

Render 🖌

I/O 🔌

Physics 🚀

Utilities 🛠️

RFID 💳

Wireless 🛜

Gates 🚥

Click To Expand

TBD

Extras 🔭

Please do not alter the e2 docs ... pages manually.
They are autogenerated from the E2Helper. In the future, this will hopefully be its own dedicated website or tool.

Default Extensions

Basic Features: core, debug, number, selfaware, string, timer
🌎 World: angle, color, find, ranger, sound,
🔣 Math: bitwise, complex, matrix, quaternion, vector, vector2/4
📦 Entities: bone, constraint, egp, entity, hologram, npc
👨 Players: chat, console, player, weapon
📊 Data storage: array, files, globalvars, serialization, table
💬 Communication: datasignal, http, signal, wirelink,
❓ Informational: gametick, serverinfo, steamidconv, unitconv

Additional Extensions

Disabled by default: constraintcore, effects, propcore, remoteupload, wiring
Wire-Extras (repo): camera, ftrace, holoanim, light, stcontrol, tracesystem

Developer resources