Skip to content
Merged
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
37 changes: 37 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
```
Pull request format:

This pull request aims to `<(specify reason)>`.

(If updating documentation due to a new feature/change)
This pull request corresponds to Dn-Programming-Core-Management/Dn-FamiTracker#`<PR number>`.

---

Changes:

- `<Describe change entry>`
- Fixes/addresses issue `#<issue number>`.

Changelog format:
- Categories
- `Important changes:`
- summary of immediate and obvious changes to the program
- `Improvements:`
- additions and refactoring
- `Bug fixes:`
- any bug fixes
- `Internal:`
- meta changes, including changes regarding to the repository or CI
- Format
- `<description of singular change> ([issue_author] [commit_author] [#<issue number>] [#<PR number>])`
- only put in issue author and number if it exists
- only put one author if issue and commit author is the same
- sort by category, then by issue number, then by PR number
- ex:
- `Fix access violation in MRU submenu list update (@eugene-s-nesdev @Gumball2415 #243 #214)`

Notice:
- Please remove this code block and fill in the details.
- Be sure to update CHANGELOG.md in the `Unreleased` section, as well as the date last updated.
```
151 changes: 151 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,151 @@
# Dn-FamiTracker Help

Change Log

Written by D.P.C.M.

Version 0.5.2.9

Last updated: January 06, 2025

---

## Unreleased - 2026-01-06

### Important changes

- ...

### Improvements

- ...

### Bug fixes

- ...

### Internal

- Move `CHANGELOG.md` to solution root folder (@Gumball2415 #15)
- Update GitHub pull request template (@Gumball2415 #15)
- Refactor HTMLHelp custom build commands (@Gumball2415 #15)
- Add change log (@Gumball2415 #15)



## Release 0.5.2 - 2026-01-06

### Important changes

- Add triangle linear counter retrigger effect description (@Gumball2415 #12)

### Improvements

- Clarify some effect descriptions (@Gumball2415 #12)

### Bug fixes

- Fix Export Wave page spelling error (@nyanpasu64 #11)

### Internal

- Implement separate changelog build command (@Gumball2415 #10)
- Refactor patch keyword to not use a comment (@Gumball2415 #10)
- Update Windows SDK version in `hlp` (@Gumball2415 Dn-Programming-Core-Management/Dn-FamiTracker#370)



## Release 0.5.1.1 - 2025-01-13

This release is made to coincide [with the 0.5.1.1 release of Dn-FamiTracker](https://github.com/Dn-Programming-Core-Management/Dn-FamiTracker/releases/tag/Dn0.5.1.1).

- Add PR template



## Release 0.5.1.0 - 2025-01-07

This release is made to coincide [with the 0.5.1.0 release of Dn-FamiTracker](https://github.com/Dn-Programming-Core-Management/Dn-FamiTracker/releases/tag/Dn0.5.1.0).

- Clarify phase reset effect description
- Add Vxx table for S5B
- Update main index, license and year
- Add groove settings, detune settings and bookmark manager to manual
- Add Dn-Help version in main index




## Release 0.5.0.2 - 2024-01-14

This release is made to coincide [with the 0.5.0.2 release of Dn-FamiTracker](https://github.com/Dn-Programming-Core-Management/Dn-FamiTracker/releases/tag/Dn0.5.0.2).

- Sync to Dn-FT repo as a submodule
- Begin to integrate markdown conversion
- Update application icon
- Generate change log page from markdown source



## Release 0.5.0.1 addenum - 2023-05-10

This release is made to provide corrections for the help manual included [in the 0.5.0.1 release of Dn-FamiTracker](https://github.com/Dn-Programming-Core-Management/Dn-FamiTracker/releases/tag/Dn0.5.0.1).

- Update .vcxproj for parity with the main project
- Rename Blue Mario to forple



## Release 0.5.0.1 - 2023-05-10

This release is made to coincide [with the 0.5.0.1 release of Dn-FamiTracker](https://github.com/Dn-Programming-Core-Management/Dn-FamiTracker/releases/tag/Dn0.5.0.1).

- Update effects list to include Nxy, Oxx, VRC7, and Sunsoft 5B effects.
- FamiTracker links now link to archived mirrors.



## Release 0.5.0.0 - 2022-12-19

This release is made to coincide [with the 0.5.0.0 release of Dn-FamiTracker](https://github.com/Dn-Programming-Core-Management/Dn-FamiTracker/releases/tag/Dn0.5.0.0).

- Update DPCM rate table to include PAL timings
- Update effects list, menu, DPCM editor, pattern editor, toolbar, control panel, NSF export info, commandline, text export, and properties pages.
- Add emulation and version configuration pages
- Update hyperlinks
- Add Kxx and =xx effects into effects list
- Add ASIC images to corresponding sound hardware pages
- Integrate 0CC-readme.txt into manual
- Clarify copyrights



## Release 0.4.0.1 - 2021-09-15

This release is made to coincide (and was released) [with the 0.4.0.1 release of Dn-FamiTracker.](https://github.com/Dn-Programming-Core-Management/Dn-FamiTracker/releases/tag/Dn0.4.0.1)

This update simply adds the changelog information from 0.4.0.0 and 0.4.0.1 into the changelog page. No other information was altered or changed.



## 5B Information Update (Version 0.3.1.5B) - 2021-07-03

- Recoded the entire Sunsoft 5B page.
- Updated the Sunsoft 5B Documentation.
- Updated FAQ to correlate better with updated 5B information.
- Updated the Main Index with links to Github.
- Additionally updated the Sound Overview information.



## Version 0.3.1.0 - 2021-06-21

Additions

- Updated the changelog to version 0.3.1.0



#### Note from Dn-FT maintainer:

Before this release, Dn-help used to be part of the main repository, where it was first reimplemented at Dn0.3.0.0. Then, Dn-help became its own subrepository, where the initial commit was made on 2021-04-30, sometime after Dn0.3.0.0.
9 changes: 0 additions & 9 deletions docs/pull_request_template.md

This file was deleted.

11 changes: 11 additions & 0 deletions hlp/compile-chm.bat
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
@REM usage: compile-chm.bat <OUTPUT_DIR>
@REM invoke this inside Dn-help/hlp
start /wait hhc "Dn-FamiTracker.hhp"
if not exist "Dn-FamiTracker.chm" goto :HelpError
move "Dn-FamiTracker.chm" "%~dp1/Dn-FamiTracker.chm"
goto :HelpDone
:HelpError
echo Dn-help\hlp\Dn-FamiTracker.hhp(1) : error:Problem encountered creating help file
echo.
:HelpDone
echo.
Loading