Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Stocks script based on pre-v50 stocks plugin #802

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions docs/stocks2.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
stocks2
========
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the underline has to match the length of the string that it is underlining


.. dfhack-tool::
:summary: Alternative to the stocks screen based on the pre-v50 stocks plugin by Falconne.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
:summary: Alternative to the stocks screen based on the pre-v50 stocks plugin by Falconne.
:summary: Stock management screen with search and filtering.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

summaries should be ~53 chars

:tags: stocks
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
:tags: stocks
:tags: fort productivity items

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.


This script is a replica of the pre-v50 stocks plugin by Falconne and it offers an
alternative way to manage items in your game world.
Comment on lines +8 to +9
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The intro here should go over the capabilities of the UI -- e.g. the mouse actions for multi-select, examples of filters you can apply, and the kinds of operations you can perform on the items.

example: https://docs.dfhack.org/en/latest/docs/tools/caravan.html#bring-item-to-depot


Usage
-----
``stocks2``
Launch the stocks2 interface
Comment on lines +13 to +14
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
``stocks2``
Launch the stocks2 interface
::
stocks2

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

preferred styling for commands that just launch a UI and don't take any parameters.

example: https://docs.dfhack.org/en/latest/docs/tools/gui/overlay.html#gui-overlay

Loading
Loading