[Débutant] GUIDE : Créer des "STweaks"

Hey, dans ce guide je vais vous expliquer très simplement comment développer des stweaks pour Simple.
Avant toute chose, je tiens à vous rappeler que les stweaks sont autorisés, mais surtout réglementés, vous devez donc suivre les règles imposées par l'administration pendant la programmation ; notez que le règlement peut changer n'importe quand et que vous devez le consulter régulièrement, voici le lien du règlement en question :

Règlement Simple-Tweaks & API

Règlement de Simple-Tweaks Ce règlement spécial est à destination des développeurs utilisant Simple-Tweaks ou l'API. Si vous n'êtes pas un développeur, il n'est pas obligatoire de le lire 1.1 Meta Gaming - Il est strictement interdit de fournir une information au joueur qu'il n'est pas capable...

simple-roleplay.fr

Que sont les stweaks ?
Les stweaks (=Simple Tweaks) sont des modules créés et hébergés en Lua par la communauté pour apporter des précisions, améliorer le gameplay, ect... : comme l'indique le mot tweaks signifiant ajustements/modifications.

Premièrement, vous aurez besoin d'un fichier comprenant tout ce qui est nécessaire pour faire fonctionner vos modules.
Pour l'obtenir, vous pouvez trouver ce fichier en pièce jointe ou/et en demandant directement a l'administration.

Ensuite, vous devrez implémenter la base de votre module en JavaScript disponible ci-dessous ou à la demande à l'administration.

const lua = require('../../lib/luaHelper.js');

const mModule = {
    name: "test",
    version: "1.0.0",
    author: "test",
    level: 1,
    admin: false,
    sadmin: false,
    comments: "test"
}

function codegen() {
    return `

`;
}

module.exports = {
    details: mModule,
    codegen
}

Une fois dans votre tout nouveau module, vous pourrez directement changer le nom, l'auteur, la version et les commentaires qui seront affichés lorsque l'utilisateur entrera la commande "stweaks_open", respectivement nommés "name", "author", "version" et "comments" au début de votre script. Une fois ces informations modifiées, vous pourrez commencer à intégrer votre code en Lua dans la partie "return", entre les deux guillemets. ( ` )

Une fois votre code terminé, vous devez le mettre dans le fichier donné auparavant en pièce jointe dans le chemin suivant : "...\simpletweaks\src\lua", avec l'extension ".js".

Pour que tout le monde ait accès a votre projet, vous devez évidemment le mettre en ligne.
Comment ?
Je ne m'attarderai pas sur l'hébergement de votre module ici pour plusieurs facteurs, si vous avez besoin d'aide vous pouvez mettre en ligne vos stweaks, veuillez contacter la modération/administration, n'importe quelle personne ayant réussi a mettre en ligne son module ou moi-même.

Pour utiliser votre module une fois terminé, vous n'avez juste qu'a, en étant connecté à Simple, écrire dans votre console "stweaks_repo_add "votrelien/api/""

Vous cherchez le nom de votre module, puis vous le chargez.
Voilà, votre module est lancé et est en ligne.

Si vous avez une question n'hésitez pas a me DM Discord : wetsn#8573


EDIT : Il est maintenant nécéssaire de faire une candidature pour publier des STweaks.

Cordialement,
Sarah Viro Aisha Khan​

 

[Octavio Rosalvo]

Bonjour Sarah Viro,

Je respecte énormément le travail et le développement que votre communauté de développeurs apporte à Garrys Mods et ses serveurs.
Tant que le but reste bienveillant, tel votre guide, je ne peut être que ravis de voir ce genre de tutoriel sur notre forum.

Merci pour ce tutoriel qui ne me servira probablement jamais, mais qui, peut être, servira à d'autres développeurs qui amélioreront le gameplay de Simple Roleplay.

Cordialement,