corneliaxaos / guidebooks Goto Github PK

This is a short list of design features for the Crafting Guide guidebook.

• Contain a "Mods" SectionGroup (sort recipes by mod)
• Contain a "Groups" SectionGroup (sort recipes by groups)
• Contain a "Types" SectionGroup (sort by craft recipe type: i.e. shaped, shapeless, cooking, fuel)
• Auto-generates a listing of all craftables within the game and sorts into the appropriate sections
• Should display detailed information on the recipe as to how to craft it, cook it, or it's fuel value.
• Recipes can be marked as hidden by a mod and have a hint supplied.

Users should be able to search the entirety of a guidebook for entries (page not in pagegroup / pagegroup) with specific names. The search bar will be displayed at the bottom of the "book" interface and pressing enter or "search" after typing something within will open a "dummy" section containing the search results. This section disappears when the user navigates to another section.

This is a short listing of the goals desired for the v1.0 API.

• Sections (Optional / Guidebook)
• Index Styles (tiles, rows, tile with header, etc.)
• Page Styles (vertical scrolling and page "flipping")
• Bookmarks Feature
• Search Feature
• Page Sharing Feature (not sure if possible..)
• Section Toggles (change what sections are displayed programmatically)

Ideally, pages should be "shareable" so that anyone with a particular guidebook can go directly to the shared section and page combination. This would ideally be done somehow through chat messages (possibly with a link if that can be done....) If not, shared pages could "queue up" in a special section of the guidebook that resets when the user logs out / server is restarted.

A bookmark should point to a specific page (possibly within a page group) within a specific section in the specified guidebook. These will be displayed opposite of the guidebook sections (out the right hand side of the "book" interface).

Skeleton code / structure for the guidebook "page" and "page group". A page is a single, displayable set of content that can be selected from an index in a section. A page group encapsulates multiple pages and allows them to be "flipped" through instead of scrolled horizontally or vertically.

• Page "Class"
• PageGroup "Class"
• Page Rendering

The primary "Guidebook" interface object that will permit other mods to "create" and "register" guidebooks.

Operations

• new
• register
• unregister
• locate

Helper Data

• Formspec limitations (index size and page size, if needed)

Certain files are required for a mod release to function appropriately. See the lua_api.txt file for more information.

• screenshot.png
• description.txt
• settingtypes.txt

Skeleton code / structure for the guidebook "index". An index is autogenerated for a section based on the pages / page groups that are contained within that section. There are some customization options for an index, however:

Index Styles

• Tiles
• Tile with Title
• Titles only

Skeleton code / structure for the guidebook "section". A section contains an index and a set of pages.
The programmer should also be able to create "SectionGroup"s and toggle between which section group is currently being displayed in the guide from a special "home" section.

• Section "Class"
• SectionGroup "Class"
• Home Section Generation
• Shared Section Generation
• Ability to add Pages and "Page Groups" to a section.

We need numerous textures for the default formspec customization:

• background: 'guidebooks_background.png'
• arrow_left: 'guidebooks_arrow_left.png'
• arrow_right: 'guidebooks_arrow_right.png'
• arrow_up: 'guidebooks_arrow_up.png'
• arrow_down: 'guidebooks_arrow_down.png'
• share_icon: 'guidebooks_share_icon.png'
• bookmark_icon: 'guidebooks_bookmark_icon.png'
• section_tab: 'guidebooks_section_tab.png'
• bookmark_tab: 'guidebooks_bookmark_tab.png'
• top_bar: 'guidebooks_top_bar.png'
• bottom_bar: 'guidebooks_bottom_bar.png'
• scroll_bar_backing: 'guidebooks_scroll_bar_backing.png'
• index_backing: 'guidebooks_index_backing.png'
• page_backing: 'guidebooks_page_backing.png'
• home_icon: 'guidebooks_home_icon.png'

These are needed in other locations (not formspec customization):

• inventory_image: 'guidebooks_inventory_image.png'

See the Github Community Profile Insights tab.

• README
• Code of Conduct
• Contributing
• License
• Issues and Pull Request Templates

Certain files are required for a mod release to function appropriately. See the lua_api.txt file for more information.

• screenshot.png
• description.txt
• settingtypes.txt
• mod.conf?