Un flux de travail d'équipe pour les projets Roblox qui garde le code dans Git, garde l'art versionné avec des packages, et permet à tout le monde de travailler sans écraser les modifications des autres.
La version courte
- Le code vit dans Git et entre dans Studio via Rojo.
- L'art vit dans Roblox sous forme de packages. Les originaux se trouvent dans un lieu d'Asset, et les copies dans le lieu de Dev se mettent à jour automatiquement.
- Tout le monde travaille dans son propre lieu d'utilisateur, puis apporte le travail terminé dans le lieu de Dev partagé.
- Stable est un instantané gelé de Dev pour les tests de jeu. Prod est le jeu en direct.
Lieux
Tous les lieux appartiennent au groupe du projet. Vérifiez toujours que le groupe est sélectionné avant de cliquer sur Publier sous.
| Lieu | But | Qui le modifie | Comment | Nom |
|---|---|---|---|---|
| Utilisateur | Votre espace de travail personnel au quotidien, copié depuis Dev | Vous | Rojo connect + Studio | USER / [Nom] - [Projet] - [Niveau] |
| Dev | Combinaison partagée et instable du travail de chacun | Tout le monde, après révision | Rojo connect pour le code, Team Create pour l'art | DEV - [Projet] |
| Asset | Les packages originaux : personnages, kits de construction, habillage | Artistes | Éditer + Publier dans le Package | ASSET / [Projet] - [Niveau] |
| Stable | Instantané gelé de Dev, utilisé pour les tests de jeu | Le script de déploiement uniquement | Automatisé | STABLE / [Projet] |
| Prod | Le jeu public | Propriétaire de la version, avec approbation | Copié depuis Stable | [Projet] |
Où vont les choses
Rojo est configuré comme partiellement géré : Git possède le code et la configuration, et le fichier de lieu possède l'art et le niveau. Chaque emplacement d'exécution (ReplicatedStorage, ServerScriptService) a deux dossiers de contenu :
| Quoi | Où | Source de vérité |
|---|---|---|
| Code (systèmes, bibliothèques) | src/… dans le dépôt | Git |
| Configuration et définitions typées (objets, quêtes, sons, mécanismes) | src/…/ManagedContent/ | Git |
| Art et tout ce qui a des MeshParts | …/Content, sous forme de packages | Le fichier de lieu et le lieu d'Asset |
| Mise en page du niveau, éclairage, terrain | Workspace / Lighting dans le lieu de Dev | Le fichier de lieu |
ManagedContent : Git est la source de vérité
- Rojo le reconstruit à partir du disque, donc les modifications dans Studio sont écrasées lors de la prochaine synchronisation. Modifiez les fichiers sur le disque.
- Les fichiers sont des modules .luau, des descripteurs .model.json, ou des instances .rbxmx.
- Pour déplacer quelque chose que vous avez construit dans Studio vers ManagedContent :
- Faites un clic droit dessus et choisissez Enregistrer dans le fichier → .rbxmx. Le format XML donne des différences lisibles, contrairement au binaire .rbxm.
- Mettez le fichier sous ManagedContent/, puis validez-le.
- Utilisez-le pour tout ce que le code lit comme configuration. La révision de code et l'historique Git le couvrent ensuite.
Contenu : le fichier de lieu est la source de vérité
- Rojo l'ignore, et il n'a pas de fichiers sur le disque, donc l'autocomplétion de l'éditeur ne peut pas le voir.
- C'est requis pour les MeshParts, car Rojo ne peut pas les synchroniser.
- Utilisez-le pour l'art que les artistes modifient dans Studio : accessoires, personnages, VFX, mise en scène.
- Ne mettez jamais de configuration possédée par le code ici. Elle devient invisible pour la révision et les différences.
- Le seul historique est l'historique des versions du lieu de Roblox, donc publiez Dev régulièrement.
Fichier de projet
Dites à Rojo de laisser Content tranquille avec $ignoreUnknownInstances :
"ReplicatedStorage": {
"$path": "src/ReplicatedStorage",
"Content": {
"$className": "Folder",
"$ignoreUnknownInstances": true
}
}Disposition du dépôt :
src/
├── ReplicatedStorage/ # partagé + client
│ ├── Systems/
│ ├── Libraries/
│ └── ManagedContent/
└── ServerScriptService/ # serveur uniquement, non répliqué
├── Systems/
├── Libraries/
└── ManagedContent/Configuration (une fois par projet)
- Clonez le dépôt et installez l'outil. Nous utilisons Rokit : exécutez rokit install pour obtenir rojo, selene, StyLua, luau-lsp et lune.
- Créez votre lieu d'utilisateur :
- Ouvrez le lieu de Dev.
- Choisissez Fichier → Publier sous, sélectionnez le groupe de projet, et créez un nouveau lieu nommé USER / [Nom] - [Projet] - [Niveau].
- Fermez Dev et ouvrez votre nouveau lieu.
- Connectez Rojo :
- Ouvrez le dépôt dans votre éditeur et exécutez rojo serve.
- Dans Studio, cliquez sur Connecter dans le plugin Rojo.
Votre lieu d'utilisateur est une copie de Dev, donc ses packages restent liés. Ils se mettent à jour vers la dernière version chaque fois que vous ouvrez le lieu.
Ingénieurs : la boucle de code
- Créez une branche à partir de main.
- Mettez à jour votre lieu d'utilisateur depuis Dev, afin de partir de la dernière mise en page et de l'art :
- Ouvrez le lieu de Dev.
- Choisissez Fichier → Publier sous, sélectionnez le groupe de projet, et choisissez votre lieu d'utilisateur existant pour le remplacer.
- Travaillez dans votre lieu d'utilisateur avec rojo serve connecté.
- Exécutez stylua (formatage) et selene (linting) avant d'ouvrir une PR.
- Ouvrez une PR et faites-la réviser.
- Une fois approuvée, fusionnez dans main.
- Synchronisez Dev :
- Exécutez git checkout main && git pull.
- Ouvrez le lieu de Dev, exécutez rojo serve, et connectez-vous.
- Si votre changement nécessite des modifications de mise en page dans le lieu, comme de nouveaux attributs ou des actifs de remplacement, ajoutez-les également à Dev. Rojo ne synchronise que le code et ManagedContent, donc il ne les apporte pas.
Ne modifiez jamais manuellement un script géré par Rojo ou ManagedContent dans Studio. La prochaine synchronisation l'efface.
Artistes : la boucle d'actifs
Changer un actif existant
- Ouvrez le lieu d'Asset et modifiez le package original.
- Faites un clic droit dessus et choisissez Publier dans le Package.
- Les copies dans Dev prennent en compte le changement :
- Les copies avec AutoUpdate se mettent à jour la prochaine fois que quelqu'un ouvre Dev.
- Si Dev est déjà ouvert, faites un clic droit sur une copie et choisissez Obtenir le dernier package. Vous pouvez également utiliser Mettre à jour tout pour mettre à jour chaque lieu du jeu.
- En option, ajoutez une note de version sous Détails du package → Versions.
Ajouter un nouvel actif
- Construisez-le dans le lieu d'Asset. Regroupez-le en tant que Modèle, même s'il s'agit d'un seul objet, afin que vous puissiez ajouter des enfants plus tard sans casser le package.
- Faites un clic droit dessus et choisissez Convertir en Package.
- Définissez Propriété au groupe de projet. La propriété ne peut pas être transférée plus tard.
- Sélectionnez son PackageLink et activez AutoUpdate.
- Ajoutez-le à Dev : dans la Boîte à outils, allez à Créations → Packages de groupe, insérez-le, et placez-le dans le Workspace ou Content.
Travail de mise en page et de niveau
- Disposez les éléments dans votre lieu d'utilisateur.
- Une fois que votre responsable approuve, copiez les modifications dans Dev. Utilisez Team Create dans Dev pour des passes de mise en page partagées.
Règles de package
- N'éditez les packages que dans le lieu d'Asset. Si vous modifiez une copie dans Dev, elle est marquée comme modifiée et cesse de se mettre à jour automatiquement. Pour corriger une modification accidentelle, faites un clic droit dessus et choisissez Annuler les modifications au package.
- Ne supprimez jamais ou ne déplacez jamais un PackageLink. Cela transforme la copie en un modèle ordinaire.
- Packages imbriqués : publiez d'abord le package intérieur, puis le package extérieur.
- Rétrogradation : allez à Détails du package → Versions, choisissez une version antérieure, et cliquez sur Soumettre.
- Comparer les versions : faites un clic droit sur le package et choisissez Options de package → Comparer les versions de package.
- AutoUpdate est désactivé par défaut. Activez AutoUpdate sur le PackageLink d'une copie pour qu'elle se mette à jour automatiquement, ou laissez-le désactivé pour mettre à jour la copie manuellement.
- Accès : partagez les packages avec le groupe afin que toute l'équipe puisse les utiliser et les modifier. Voir Confidentialité des actifs.
Versions : Dev → Stable → Prod
Dev → Stable (script de déploiement)
Écrivez un petit script de déploiement ; Lune fonctionne bien pour cela. Exécutez-le selon un calendrier ou avant chaque test de jeu. Il doit :
- Télécharger le lieu Dev actuel, afin qu'il inclue le Contenu, le Workspace et l'éclairage.
- Supprimer chaque PackageLink. Les packages deviennent des modèles ordinaires, donc Stable est gelé et ne changera pas lorsque les artistes publieront de nouvelles versions de package.
- Publier le résultat dans le lieu Stable avec l'API de publication de lieu Open Cloud. Vous avez besoin d'une clé API avec la permission assets et un accès Lecture et Écriture, plus l'ID du lieu.
Les testeurs obtiennent une version stable pendant que l'équipe continue de travailler dans Dev. Personne ne modifie Stable manuellement.
Stable → Prod
Le propriétaire de la version copie Stable dans Prod, et uniquement avec approbation. Prod est en direct, donc personne d'autre ne le touche.
Communication
Donnez à chaque projet un canal général, un canal d'ingénierie (liens PR, discussions techniques), et un canal artistique (WIPs, révisions).