Sharp Stock

English

简体中文

English

简体中文

Best Practices ​

This chapter summarizes core recommendations for efficiently using Sharp Stock in team collaboration, covering asset organization, version control, and daily maintenance.

1. Asset Organization and Project Structure ​

A clear and standardized directory structure is the foundation for efficient retrieval and automated management.

Unify Classification Logic ​

We recommend teams unify their organization by Type or Feature Module based on project scale, maintaining consistency across levels:

  • By Type (Recommended): Assets/Characters, Assets/UI, Assets/Audio.
  • By Feature Module: ProjectA/Characters, ProjectB/UI.

Maintain Asset Independence ​

  • Single Responsibility: Avoid mixing multiple types of assets in one folder (e.g., putting audio files and 3D models together).
  • Directory Isolation: We suggest establishing independent subfolders for each complex asset (such as Spine animations containing multiple related files). This helps the software analyze assets more accurately.

2. Version Control Standards ​

Since Sharp Stock uses a centralized database (assetlib.db) to manage metadata, standardized version control habits can effectively prevent collaboration conflicts.

Repository Management Recommendations ​

  • Dedicated Repository: We strongly recommend establishing an independent and dedicated SVN repository for your asset library.
  • Separation of Duties: We suggest managing the asset library (resources about to enter the engine) separately from underlying code and large original art source files (such as massive PSDs) to ensure accurate asset positioning and update speeds.

Essential Ignore Items (Ignore) ​

To ensure database integrity and reduce operational conflicts, you must configure the following SVN ignore items in the asset library root:

  • *.db-shm
  • *.db-wal

IMPORTANT

These are temporary log files generated during database operation, valid only locally and changing frequently. Please be sure not to commit them to the repository, otherwise, it will prevent other team members from opening or updating the asset library normally.

Change Monitoring Scope ​

Sharp Stock automatically monitors the change status of the following paths in real-time:

  • assets/ directory (original resource files)
  • thumbnails/ directory (thumbnail cache)
  • assetlib.db file (core asset library database)

Operational Consistency Guidelines ​

  • Avoid External Operations: Please avoid moving, renaming, or deleting contents under the assets/ directory on a large scale within the operating system's file manager (e.g., Windows Explorer).
  • Recommend In-App Operations: All asset renaming, moving, property editing, and thumbnail updates should be completed through the Sharp Stock interface. This ensures that physical disk files remain in sync with the underlying database (tags, notes, unique IDs, etc.), preventing "invalid links" or data loss.

3. Daily Maintenance Recommendations ​

  • Manual Scan: If small-scale manual operations were performed externally for special reasons, we recommend immediately executing a "Manual Scan" within the software to synchronize the database state.