Difference between revisions of "Manual:Contents"

From Mudlet
Jump to navigation Jump to search
(Undo revision 2277 by Barabara (talk) Spam Links insertion undone)
 
(add ansi page for devs)
 
(34 intermediate revisions by 6 users not shown)
Line 1: Line 1:
 +
<languages/>
 +
 
<!--{{Hubs|banner|dev=y|admin=y}}-->
 
<!--{{Hubs|banner|dev=y|admin=y}}-->
[[File:Mudlet-Manual.png|right|175px|Mudlet documentation]]
+
[[File:{{#setmainimage:Mudlet-Manual.png}}|right|175px|<translate><!--T:1--> Mudlet documentation</translate>]]
This is a '''technical manual for the Mudlet software'''. It contains information for '''developers''' and '''end users''' on '''using''' and '''developing''' for the Mudlet software.
+
<translate>
 +
<!--T:2-->
 +
This is a manual for both Mudlet users and developers on using, or developing, Mudlet.
 +
</translate>
  
<!--This manual is '''not for end users''' of MediaWiki. If you are looking for '''documentation to help you use MediaWiki, read the [[Help:Contents|MediaWiki Handbook]].'''-->
+
<translate>
 
+
==Main sections== <!--T:3-->
==Main sections==
+
</translate>
 
{| class="MainPageBG" style="width:100%; border:1px solid #c9c07f; background:#fdf7bb; vertical-align:top; color:#000;" |
 
{| class="MainPageBG" style="width:100%; border:1px solid #c9c07f; background:#fdf7bb; vertical-align:top; color:#000;" |
 
!- style="width:50%; vertical-align:top; padding-left:2px border:none" |
 
!- style="width:50%; vertical-align:top; padding-left:2px border:none" |
==For End Users==
+
<translate>
 +
==For game players== <!--T:4-->
 +
 
 
!- style="width:50%; vertical-align:top; padding-left:2px border:none" |
 
!- style="width:50%; vertical-align:top; padding-left:2px border:none" |
==For Developers==
+
 
 +
==For game developers== <!--T:5-->
 +
 
 +
<!--T:6-->
 
|-
 
|-
 
| style="width:50%; vertical-align:top; border:none" |
 
| style="width:50%; vertical-align:top; border:none" |
 
; Guide to using Mudlet client.
 
; Guide to using Mudlet client.
[[Manual:Introduction|Introduction to Mudlet]] | [[Manual:Technical Manual|Technical Manual]] | [[Manual:Migrating|Migrating to Mudlet]]
+
[[Special:MyLanguage/Manual:Introduction|Introduction to Mudlet]] | [[Special:MyLanguage/Manual:Technical Manual|Technical Manual]] | [[Special:MyLanguage/Manual:Migrating|Migrating to Mudlet]]
 
; Enhancing your Mudlet experience.
 
; Enhancing your Mudlet experience.
[[Manual:Scripting|Scripting]] | [[Manual:Lua Functions | Lua API and Reference]] | [[VyzorGuide|Vyzor Guide]] | [[Manual:Geyser| Geyser Guide]]
+
[[Special:MyLanguage/Manual:Scripting|Scripting]] | [[Special:MyLanguage/Manual:Lua Functions | Lua API and Reference]] | [[Special:MyLanguage/Manual:Geyser| Geyser Guide]]
 
| style="width:50%; vertical-align:top; border:none" |
 
| style="width:50%; vertical-align:top; border:none" |
 
; Architecture
 
; Architecture
: An overview of the key parts of Mudlet's source code.
+
: Everything needed to start contributing to Mudlet.
: [[Manual:Code|Code]] | [[Manual:Global object variables|Global object variables]] | [[Compiling Mudlet | Compiling Mudlet]]
+
: [[Special:MyLanguage/Compiling Mudlet | Compiling Mudlet]] | [[Special:MyLanguage/Infrastructure_Overview | Infrastructure Overview]] | [[Special:MyLanguage/Relevant_Developer_Tutorials|Links to read]] | [[Special:MyLanguage/Manual:Testing|Testing]] | [[Special:MyLanguage/Manual:Versioning|Versioning]]
 +
; For game developers/admins
 +
: [[Special:MyLanguage/Websockets | Websockets]] | [[Special:MyLanguage/Manual:Scripting#Discord_Rich_Presence|Discord Rich Presence]] | [https://github.com/g7138580/protocol_gmcp Greg's GMCP snippet] | [[Special:MyLanguage/Ansi_escape_code | ANSI]]
 
|}
 
|}
 +
</translate>
  
=== Others ===
+
<translate>
; [[FAQ|Mudlet FAQ]]
+
=== Others === <!--T:7-->
 +
 
 +
<!--T:8-->
 +
; [[Special:MyLanguage/FAQ|Mudlet FAQ]]
 
: Frequently asked questions about Mudlet.
 
: Frequently asked questions about Mudlet.
  
== Browsing the manual ==
+
== Browsing the manual == <!--T:9-->
There are multiple ways to browse through the documentation.  Readers having trouble finding a particular topic in the section above or the [[#Categories|category]] list may find the following ways of browsing to be helpful.
+
 
* [[Special:Allpages/Manual:]] - An automatically generated list of all pages in the Manual: namespace.
+
<!--T:10-->
* [[:Category:Mudlet Manual]] - the top-level Manual category
+
There are multiple ways to browse through the documentation.  Readers having trouble finding a particular topic in the section above or the [[Special:MyLanguage/#categories|category]] list may find the following ways of browsing to be helpful.
 +
* [[Special:Allpages/Manual:|Special:Allpages/Manual:]] - An automatically generated list of all pages in the Manual: namespace.
 +
* [[:Category:Mudlet Manual|:Category:Mudlet Manual]] - the top-level Manual category
 +
 
 +
 
 +
== Improving the manual == <!--T:11-->
 +
 
 +
<!--T:12-->
 +
* There are still a lot of holes in this manual!  See the [[Special:MyLanguage/Manual:To do|'to do' page]] for details.
 +
* If you can't find information on a particular issue in this documentation, please visit [https://forums.mudlet.org/ The Mudlet Forum] and ask your question there and someone will help you.
 +
* '''[[Project:Manual|Project:Manual]]''' is a place to discuss and co-ordinate the development of the Manual: namespace.
 +
* See also [[Project:Current issues|Project:Current issues]].
 +
</translate>
  
== Improving the manual ==
 
* There are still a lot of holes in this manual!  See the [[Manual:To do|'to do' page]] for details.
 
* There is still content on [http://mudlet.git.sourceforge.net/git/gitweb.cgi?p=mudlet/mudlet;a=blob_plain;f=src/mudlet_documentation.html;hb=HEAD The Mudlet Manual] which may need to be migrated.  If you can't find information on a particular issue in this documentation, please visit [http://mudlet.org/forums The  Mudlet Forum] and ask your question there and someone will help you.
 
* '''[[Project:Manual]]''' is a place to discuss and co-ordinate the development of the Manual: namespace.
 
* See also [[Project:Current issues]].
 
 
<!--
 
<!--
{{Languages}}
 
  
 
{{Categories}}
 
{{Categories}}
  
 
{{Mudlet Manual list}}
 
{{Mudlet Manual list}}
 +
 
-->
 
-->
 +
<translate>
 +
<!--T:13-->
 
[[Category: Mudlet Manual]]
 
[[Category: Mudlet Manual]]
 +
</translate>

Latest revision as of 06:34, 9 July 2024

Other languages:
Deutsch • ‎English • ‎Nederlands • ‎Türkçe • ‎français • ‎italiano • ‎polski • ‎suomi • ‎Ελληνικά • ‎русский • ‎العربية • ‎한국어
Mudlet documentation

This is a manual for both Mudlet users and developers on using, or developing, Mudlet.

Main sections

For game players

For game developers

Guide to using Mudlet client.

Introduction to Mudlet | Technical Manual | Migrating to Mudlet

Enhancing your Mudlet experience.

Scripting | Lua API and Reference | Geyser Guide

Architecture
Everything needed to start contributing to Mudlet.
Compiling Mudlet | Infrastructure Overview | Links to read | Testing | Versioning
For game developers/admins
Websockets | Discord Rich Presence | Greg's GMCP snippet | ANSI

Others

Mudlet FAQ
Frequently asked questions about Mudlet.

Browsing the manual

There are multiple ways to browse through the documentation. Readers having trouble finding a particular topic in the section above or the category list may find the following ways of browsing to be helpful.


Improving the manual

  • There are still a lot of holes in this manual! See the 'to do' page for details.
  • If you can't find information on a particular issue in this documentation, please visit The Mudlet Forum and ask your question there and someone will help you.
  • Project:Manual is a place to discuss and co-ordinate the development of the Manual: namespace.
  • See also Project:Current issues.