server-plugin-template/PluginTemplateClient.xml at main · CometWorks/server-plugin-template · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
<?xml version="1.0"?>
<PluginData xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="GitHubPlugin">

    <!-- The ID of your plugin, never change this -->
    <Id>A061FC6C-713E-42CD-B413-151AC8A5074C</Id>

    <!-- GitHub repository ID -->
    <RepoId>todo-github-user/project-name</RepoId>

    <!-- The name of your plugin that will appear in the plugin list -->
    <FriendlyName>TODO PluginTemplateClient</FriendlyName>

    <!-- The author name that you want to appear in the plugin list -->
    <Author>TODO Author Name</Author>

    <!-- Optional tooltip for the plugin in the plugin list -->
    <Tooltip>TODO Short description</Tooltip>

    <!-- Optional plugin description. If omitted, this will be the same as the Tooltip. 1000 characters max. -->
    <Description>TODO Long description, multiple lines.

        This text is shown on the plugin details panel in a scrollable text box.

        You can use links here, players can click on them. For example, add a Discord invite.
    </Description>

    <!-- Only source code in the Directory entries listed in SourceDirectories is compiled. Exclude any test projects or similar. -->
    <SourceDirectories>
        <Directory>ClientPlugin</Directory>
        <Directory>Shared</Directory>
    </SourceDirectories>

    <!-- To specify asset files to be copied onto disk, use the AssetFolder tag.
    <AssetFolder>Project/Assets/</AssetFolder>
    -->

    <!-- To specify a required NuGet package, use either a list of PackageReference tags OR a Config tag.
    <NuGetReferences>
      <PackageReference Include="OVRSharp" Version="1.2.0" />
    </NuGetReferences>
    -->

    <!-- Optional tag that specifies what dependencies this plugin has. Dependencies will be automatically enabled when this plugin is enabled.
    <DependencyIds>
      <Id>TODO ID of the plugin this one depends on</Id>
    </DependencyIds>
    -->

    <!-- Optional tag that restricts the plugin to specific runtimes (case sensitive: NETFramework, NETCoreApp). List multiple, comma separated. If omitted, the runtime is detected from the compiled assembly.
    <Runtimes>NETFramework,NETCoreApp</Runtimes>
    -->

    <!-- Optional tag that restricts the plugin to specific platforms (case sensitive: Windows, Linux). List multiple, comma separated. If omitted, the plugin loads on all platforms.
    <Platforms>Windows,Linux</Platforms>
    -->

    <!-- Optional tag that specifies whether the plugin is hidden. Hidden plugins only appear when they are enabled or searched for in the search box.
    <Hidden>true</Hidden>
    -->

    <!-- The current plugin version's commit hash -->
    <Commit>TODO Git commit hash</Commit>

    <!-- Optional list of alternate versions of the plugin, use it for test or custom builds
    <AlternateVersions>
      <Version>
        <Name>Version Name</Name>
        <Commit>Commit hash</Commit>
      </Version>
    </AlternateVersions>
    -->

    <!-- Feel free to delete the comments and the commented out optional blocks once you're done. -->

</PluginData>