OpenTabletDriver / OpenTabletDriver/opentabletdriver.github.io

Manual plugin install instructions are missing

Open
#237 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement good first issue wiki
Dominant language
HTML
Stars
36
Forks
10
Avg merge
12h 32m
Merged PRs (30d)
9

Description

This can be relevant for users which have internet issues, or for some other reason have a plugin manager that isn't working correctly.

The gist is:

  • Make Plugins folder in OTD's appdata
  • Make dedicated folder for the plugin - same name as the zip is suggested
  • Put all relevant dll files into the folder

Example final application directory structure:

/OTD-appdata/settings.json
/OTD-appdata/Plugins/MyPlugin/MyPlugin.dll
/OTD-appdata/Plugins/MyPlugin/SomeDependency.dll

The appdata location is documented at https://opentabletdriver.net/Wiki/FAQ/General#appdata

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the FAQ/General page linked in the issue and locate the existing appdata documentation. Add a manual plugin installation section covering the Plugins folder, a dedicated plugin folder, DLL dependencies, and the example directory structure. Done means users without a working plugin manager can follow the instructions to install a plugin.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.