Skip to content

Commit 15c1684

Browse files
neogeekneogeek
committed
Updated README.md
1 parent fd97425 commit 15c1684

File tree

4 files changed

+28
-264
lines changed

4 files changed

+28
-264
lines changed

‎Documentation/Install.md‎

Lines changed: 7 additions & 66 deletions
Original file line numberDiff line numberDiff line change
@@ -19,76 +19,17 @@
1919

2020
### Godot
2121

22-
#### C#
23-
24-
1. Clone this repo locally (using either a tagged release or the main development branch).
25-
1. Update your `.csproj` file to include a reference to the project:
26-
27-
```xml
28-
<ItemGroup>
29-
<ProjectReference
30-
Include="$(HOME)/git/github/rhythm-game-utilities/RhythmGameUtilities/RhythmGameUtilities.csproj" />
31-
</ItemGroup>
32-
```
33-
34-
1. Add config to your `.csproj` file to copy the library files before a build:
35-
36-
```xml
37-
<ItemGroup Condition="$([MSBuild]::IsOSPlatform('Windows'))">
38-
<None
39-
Include="$(HOME)/git/github/rhythm-game-utilities/RhythmGameUtilities/Libs/Windows/libRhythmGameUtilities.dll">
40-
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
41-
</None>
42-
</ItemGroup>
43-
44-
<ItemGroup Condition="$([MSBuild]::IsOSPlatform('OSX'))">
45-
<None
46-
Include="$(HOME)/git/github/rhythm-game-utilities/RhythmGameUtilities/Libs/macOS/libRhythmGameUtilities.dylib">
47-
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
48-
</None>
49-
</ItemGroup>
50-
51-
<ItemGroup Condition="$([MSBuild]::IsOSPlatform('Linux'))">
52-
<None
53-
Include="$(HOME)/git/github/rhythm-game-utilities/RhythmGameUtilities/Libs/Linux/libRhythmGameUtilities.so">
54-
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
55-
</None>
56-
</ItemGroup>
57-
```
58-
59-
1. Create a new script for telling Godot where the library files are located:
22+
#### GDScript
6023

61-
```csharp
62-
using System;
63-
using System.IO;
64-
using System.Runtime.InteropServices;
65-
using Godot;
24+
Download and install the latest release (coming soon).
6625

67-
public partial class AutoSetupRhythmGameUtilities : Node
68-
{
69-
public override void _Ready()
70-
{
71-
NativeLibrary.SetDllImportResolver(typeof(RhythmGameUtilities.Common).Assembly,
72-
(name, assembly, path) =>
73-
{
74-
var libDir = Path.Combine(AppDomain.CurrentDomain.BaseDirectory, "Libs");
26+
#### C#
7527

76-
return name switch
77-
{
78-
"libRhythmGameUtilities.dll" =>
79-
NativeLibrary.Load(Path.Combine(libDir, "Windows", name)),
80-
"libRhythmGameUtilities.dylib" =>
81-
NativeLibrary.Load(Path.Combine(libDir, "macOS", name)),
82-
"libRhythmGameUtilities.so" =>
83-
NativeLibrary.Load(Path.Combine(libDir, "Linux", name)),
84-
_ => NativeLibrary.Load(name, assembly, path)
85-
};
86-
});
87-
}
88-
}
89-
```
28+
Install the nuget package [com.neogeek.rhythm-game-utilities](https://www.nuget.org/packages/com.neogeek.rhythm-game-utilities/) via the CLI or from within your IDE.
9029

91-
1. Open **Project** > **Project Settings** >> **Globals** and add the script from above to the top of the list.
30+
```bash
31+
dotnet add package com.neogeek.rhythm-game-utilities --version 1.0.0-alpha.3
32+
```
9233

9334
### SDL
9435

‎README.md‎

Lines changed: 7 additions & 66 deletions
Original file line numberDiff line numberDiff line change
@@ -103,76 +103,17 @@ This library aims to offer support for multiple platforms through a single codeb
103103

104104
### Godot
105105

106-
#### C#
107-
108-
1. Clone this repo locally (using either a tagged release or the main development branch).
109-
1. Update your `.csproj` file to include a reference to the project:
106+
#### GDScript
110107

111-
```xml
112-
<ItemGroup>
113-
<ProjectReference
114-
Include="$(HOME)/git/github/rhythm-game-utilities/RhythmGameUtilities/RhythmGameUtilities.csproj" />
115-
</ItemGroup>
116-
```
108+
Download and install the latest release (coming soon).
117109

118-
1. Add config to your `.csproj` file to copy the library files before a build:
119-
120-
```xml
121-
<ItemGroup Condition="$([MSBuild]::IsOSPlatform('Windows'))">
122-
<None
123-
Include="$(HOME)/git/github/rhythm-game-utilities/RhythmGameUtilities/Libs/Windows/libRhythmGameUtilities.dll">
124-
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
125-
</None>
126-
</ItemGroup>
127-
128-
<ItemGroup Condition="$([MSBuild]::IsOSPlatform('OSX'))">
129-
<None
130-
Include="$(HOME)/git/github/rhythm-game-utilities/RhythmGameUtilities/Libs/macOS/libRhythmGameUtilities.dylib">
131-
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
132-
</None>
133-
</ItemGroup>
134-
135-
<ItemGroup Condition="$([MSBuild]::IsOSPlatform('Linux'))">
136-
<None
137-
Include="$(HOME)/git/github/rhythm-game-utilities/RhythmGameUtilities/Libs/Linux/libRhythmGameUtilities.so">
138-
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
139-
</None>
140-
</ItemGroup>
141-
```
142-
143-
1. Create a new script for telling Godot where the library files are located:
110+
#### C#
144111

145-
```csharp
146-
using System;
147-
using System.IO;
148-
using System.Runtime.InteropServices;
149-
using Godot;
150-
151-
public partial class AutoSetupRhythmGameUtilities : Node
152-
{
153-
public override void _Ready()
154-
{
155-
NativeLibrary.SetDllImportResolver(typeof(RhythmGameUtilities.Common).Assembly,
156-
(name, assembly, path) =>
157-
{
158-
var libDir = Path.Combine(AppDomain.CurrentDomain.BaseDirectory, "Libs");
159-
160-
return name switch
161-
{
162-
"libRhythmGameUtilities.dll" =>
163-
NativeLibrary.Load(Path.Combine(libDir, "Windows", name)),
164-
"libRhythmGameUtilities.dylib" =>
165-
NativeLibrary.Load(Path.Combine(libDir, "macOS", name)),
166-
"libRhythmGameUtilities.so" =>
167-
NativeLibrary.Load(Path.Combine(libDir, "Linux", name)),
168-
_ => NativeLibrary.Load(name, assembly, path)
169-
};
170-
});
171-
}
172-
}
173-
```
112+
Install the nuget package [com.neogeek.rhythm-game-utilities](https://www.nuget.org/packages/com.neogeek.rhythm-game-utilities/) via the CLI or from within your IDE.
174113

175-
1. Open **Project** > **Project Settings** >> **Globals** and add the script from above to the top of the list.
114+
```bash
115+
dotnet add package com.neogeek.rhythm-game-utilities --version 1.0.0-alpha.3
116+
```
176117

177118
### SDL
178119

‎RhythmGameUtilities/README.md‎

Lines changed: 7 additions & 66 deletions
Original file line numberDiff line numberDiff line change
@@ -103,76 +103,17 @@ This library aims to offer support for multiple platforms through a single codeb
103103

104104
### Godot
105105

106-
#### C#
107-
108-
1. Clone this repo locally (using either a tagged release or the main development branch).
109-
1. Update your `.csproj` file to include a reference to the project:
106+
#### GDScript
110107

111-
```xml
112-
<ItemGroup>
113-
<ProjectReference
114-
Include="$(HOME)/git/github/rhythm-game-utilities/RhythmGameUtilities/RhythmGameUtilities.csproj" />
115-
</ItemGroup>
116-
```
108+
Download and install the latest release (coming soon).
117109

118-
1. Add config to your `.csproj` file to copy the library files before a build:
119-
120-
```xml
121-
<ItemGroup Condition="$([MSBuild]::IsOSPlatform('Windows'))">
122-
<None
123-
Include="$(HOME)/git/github/rhythm-game-utilities/RhythmGameUtilities/Libs/Windows/libRhythmGameUtilities.dll">
124-
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
125-
</None>
126-
</ItemGroup>
127-
128-
<ItemGroup Condition="$([MSBuild]::IsOSPlatform('OSX'))">
129-
<None
130-
Include="$(HOME)/git/github/rhythm-game-utilities/RhythmGameUtilities/Libs/macOS/libRhythmGameUtilities.dylib">
131-
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
132-
</None>
133-
</ItemGroup>
134-
135-
<ItemGroup Condition="$([MSBuild]::IsOSPlatform('Linux'))">
136-
<None
137-
Include="$(HOME)/git/github/rhythm-game-utilities/RhythmGameUtilities/Libs/Linux/libRhythmGameUtilities.so">
138-
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
139-
</None>
140-
</ItemGroup>
141-
```
142-
143-
1. Create a new script for telling Godot where the library files are located:
110+
#### C#
144111

145-
```csharp
146-
using System;
147-
using System.IO;
148-
using System.Runtime.InteropServices;
149-
using Godot;
150-
151-
public partial class AutoSetupRhythmGameUtilities : Node
152-
{
153-
public override void _Ready()
154-
{
155-
NativeLibrary.SetDllImportResolver(typeof(RhythmGameUtilities.Common).Assembly,
156-
(name, assembly, path) =>
157-
{
158-
var libDir = Path.Combine(AppDomain.CurrentDomain.BaseDirectory, "Libs");
159-
160-
return name switch
161-
{
162-
"libRhythmGameUtilities.dll" =>
163-
NativeLibrary.Load(Path.Combine(libDir, "Windows", name)),
164-
"libRhythmGameUtilities.dylib" =>
165-
NativeLibrary.Load(Path.Combine(libDir, "macOS", name)),
166-
"libRhythmGameUtilities.so" =>
167-
NativeLibrary.Load(Path.Combine(libDir, "Linux", name)),
168-
_ => NativeLibrary.Load(name, assembly, path)
169-
};
170-
});
171-
}
172-
}
173-
```
112+
Install the nuget package [com.neogeek.rhythm-game-utilities](https://www.nuget.org/packages/com.neogeek.rhythm-game-utilities/) via the CLI or from within your IDE.
174113

175-
1. Open **Project** > **Project Settings** >> **Globals** and add the script from above to the top of the list.
114+
```bash
115+
dotnet add package com.neogeek.rhythm-game-utilities --version 1.0.0-alpha.3
116+
```
176117

177118
### SDL
178119

‎UnityPackage/README.md‎

Lines changed: 7 additions & 66 deletions
Original file line numberDiff line numberDiff line change
@@ -103,76 +103,17 @@ This library aims to offer support for multiple platforms through a single codeb
103103

104104
### Godot
105105

106-
#### C#
107-
108-
1. Clone this repo locally (using either a tagged release or the main development branch).
109-
1. Update your `.csproj` file to include a reference to the project:
106+
#### GDScript
110107

111-
```xml
112-
<ItemGroup>
113-
<ProjectReference
114-
Include="$(HOME)/git/github/rhythm-game-utilities/RhythmGameUtilities/RhythmGameUtilities.csproj" />
115-
</ItemGroup>
116-
```
108+
Download and install the latest release (coming soon).
117109

118-
1. Add config to your `.csproj` file to copy the library files before a build:
119-
120-
```xml
121-
<ItemGroup Condition="$([MSBuild]::IsOSPlatform('Windows'))">
122-
<None
123-
Include="$(HOME)/git/github/rhythm-game-utilities/RhythmGameUtilities/Libs/Windows/libRhythmGameUtilities.dll">
124-
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
125-
</None>
126-
</ItemGroup>
127-
128-
<ItemGroup Condition="$([MSBuild]::IsOSPlatform('OSX'))">
129-
<None
130-
Include="$(HOME)/git/github/rhythm-game-utilities/RhythmGameUtilities/Libs/macOS/libRhythmGameUtilities.dylib">
131-
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
132-
</None>
133-
</ItemGroup>
134-
135-
<ItemGroup Condition="$([MSBuild]::IsOSPlatform('Linux'))">
136-
<None
137-
Include="$(HOME)/git/github/rhythm-game-utilities/RhythmGameUtilities/Libs/Linux/libRhythmGameUtilities.so">
138-
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
139-
</None>
140-
</ItemGroup>
141-
```
142-
143-
1. Create a new script for telling Godot where the library files are located:
110+
#### C#
144111

145-
```csharp
146-
using System;
147-
using System.IO;
148-
using System.Runtime.InteropServices;
149-
using Godot;
150-
151-
public partial class AutoSetupRhythmGameUtilities : Node
152-
{
153-
public override void _Ready()
154-
{
155-
NativeLibrary.SetDllImportResolver(typeof(RhythmGameUtilities.Common).Assembly,
156-
(name, assembly, path) =>
157-
{
158-
var libDir = Path.Combine(AppDomain.CurrentDomain.BaseDirectory, "Libs");
159-
160-
return name switch
161-
{
162-
"libRhythmGameUtilities.dll" =>
163-
NativeLibrary.Load(Path.Combine(libDir, "Windows", name)),
164-
"libRhythmGameUtilities.dylib" =>
165-
NativeLibrary.Load(Path.Combine(libDir, "macOS", name)),
166-
"libRhythmGameUtilities.so" =>
167-
NativeLibrary.Load(Path.Combine(libDir, "Linux", name)),
168-
_ => NativeLibrary.Load(name, assembly, path)
169-
};
170-
});
171-
}
172-
}
173-
```
112+
Install the nuget package [com.neogeek.rhythm-game-utilities](https://www.nuget.org/packages/com.neogeek.rhythm-game-utilities/) via the CLI or from within your IDE.
174113

175-
1. Open **Project** > **Project Settings** >> **Globals** and add the script from above to the top of the list.
114+
```bash
115+
dotnet add package com.neogeek.rhythm-game-utilities --version 1.0.0-alpha.3
116+
```
176117

177118
### SDL
178119

0 commit comments

Comments
 (0)