Modding: Pour débuter

From Vintage Story Wiki
Revision as of 19:22, 15 July 2024 by Voxay (talk | contribs) (Created page with "En effet, presque toutes les fonctionnalités du jeu reposent sur l'utilisation de '''JSONs''', qui sont des documents textuels utilisant une syntaxe facile à lire. Vous pouvez ouvrir ces fichiers avec n'importe quel éditeur de texte et, avec un peu de pratique, vous apprendrez à les formater pour éviter les erreurs. La meilleure façon d'apprendre cela est d'étudier les JSON existants qui sont visibles par toute personne ayant installé le jeu. Pour ce faire, vous...")
Other languages:

Cette page a été vérifiée pour la dernière fois pour Vintage Story avec la version 1.19.6.


Vintage Story dispose d'un système de modding complet intégré au jeu, permettant à tout utilisateur d'apporter les modifications et les ajouts qu'il juge nécessaires.

Avant de commencer, il est important de comprendre ce que vous souhaitez accomplir afin de savoir à quoi vous attendre.

Chercher dans le wiki

Par défaut, la fonction de recherche du wiki exclut les pages de modding. Pour mettre à jour vos préférences de recherche, cliquez sur le bouton "Recherche Modding" ci-dessous. La page de résultats montrera que les espaces de noms (Main), BlockJson, et Modding sont cochés. Cochez la case "Mémoriser la sélection pour les recherches futures", puis cliquez sur le bouton "Recherche" pour enregistrer les modifications.

Quels Mods puis-je faire ?

Le système de modding actuel de Vintage Story est incroyablement flexible et très facile à utiliser, même si vous ne savez pas programmer. Vous pouvez ajouter des blocs, des objets et même des entités dans le jeu sans jamais ouvrir un IDE. Mais des modifications et des systèmes plus complexes peuvent être réalisés en programmant en C#.

En effet, presque toutes les fonctionnalités du jeu reposent sur l'utilisation de JSONs, qui sont des documents textuels utilisant une syntaxe facile à lire. Vous pouvez ouvrir ces fichiers avec n'importe quel éditeur de texte et, avec un peu de pratique, vous apprendrez à les formater pour éviter les erreurs. La meilleure façon d'apprendre cela est d'étudier les JSON existants qui sont visibles par toute personne ayant installé le jeu. Pour ce faire, vous devez localiser le dossier Vintage Story Assets, que vous pouvez découvrir sur la page Asset System.
En outre, voici une vidéo de 12 minutes qui vous apprendra pourquoi le json est utilisé et la syntaxe de base, ce qui facilitera la compréhension du reste de la documentation.

If you're looking to add more complex systems to Vintage story you can accomplish this as well, but you likely won't be able to do this with JSONs alone. Vintage Story is written in C#, and it is highly suggested you learn the basics of programming and of C# in general before moving onto more complex mods that can't be accomplished with just JSONs.

Types of Mods

In general there are 3 main types of mods one can create for Vintage Story, with each having different levels of complexity:

  • Theme Packs: These are mods that only affect visuals and don't add more content or change features significantly.
  • Content Mods: These are mods that add additional content (i.e. blocks, items, mobs) to the game but don't utilize C# code and are mostly limited to JSONs.
  • Code Mods: These are mods that add more complex features and systems that require the use of C# code to accomplish.

Moving Forward

If you're just starting out, it's best to begin with a content mod, as most code mods simply extend the features of blocks, items and entities made from a content mod anyway. Once you've mastered content mods you can move onto coding if you want to add some really special things to your Vintage Story experience.

More advanced programmers may be tempted to jump to code mods immediately, but it is still highly suggested you familiarize yourself with content mods first since you'll almost certainly be using them in tandem with any C# code you write.

The first thing to do while starting your first mod is to familiarize yourself with the Asset System. This is where most of the magic in Vintage Story is accomplished, and you'll be using these resources constantly while modding.

To move on with a content mod, head over to the Content Mods page. To start with a theme pack, head over to the Theme Pack page.

Icon Sign.png

Wondering where some links have gone?
The modding navbox is going through some changes! Check out Navigation Box Updates for more info and help finding specific pages.

Modding
Modding Introduction Getting Started Theme Pack
Content Modding Content Mods Developing a Content Mod Basic Tutorials Intermediate Tutorials Advanced Tutorials Content Mod Concepts
Code Modding Code Mods Setting up your Development Environment
Property Overview ItemEntityBlockBlock BehaviorsBlock ClassesBlock EntitiesBlock Entity BehaviorsWorld properties
Workflows & Infrastructure Modding Efficiency TipsMod-engine compatibilityMod ExtensibilityVS Engine
Additional Resources Community Resources Modding API Updates Programming Languages List of server commandsList of client commandsClient startup parametersServer startup parameters
Example ModsAPI DocsGitHub Repository