HughXuechen commited on
Commit
2c77090
·
verified ·
1 Parent(s): 31ab1f1

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +26 -17
README.md CHANGED
@@ -5,45 +5,54 @@ license: mit
5
 
6
  ## Original Source Attribution
7
  This dataset is derived from the work of Staffan Björk and Jussi Holopainen. The original content comes from "Patterns in Game Design," published by Charles River Media in 2005.
8
- - Original authors: Jussi Kuittinen, Staffan Björk and Jussi Holopainen
9
- - Original format: HTML documents publicly available at: https://www.researchgate.net/publication/379683418_collection.zip
10
- - Citation: Bjork, S., & Holopainen, J. (2005). Patterns in game design (Vol. 11). Charles River Media Hingham.
11
 
12
  ## Dataset Preparation
13
  This dataset represents a cleaned and structured JSON version of the original HTML content, prepared to facilitate machine learning, knowledge graph applications, and other computational approaches to game design research.
14
 
15
  ## Dataset Curator
16
- - Name: Liu, Hugh Xuechen
17
- - Contact: https://hughxuechen.github.io/
18
- - Affiliation: Chalmers Univeristy of Technology
19
 
20
  ## Version History
21
 
 
 
 
 
 
 
 
 
 
22
  ### v1.2.2 (April 26 2025)
23
  - Pattern links in Example sections are now converted to [[Pattern]] format
24
 
25
  ### v1.2.1 (April 24 2025)
26
- - Added functionality to export all pattern links to a CSV file
27
- - The CSV includes source pattern, target pattern name, and target file name
28
 
29
 
30
  ### v1.2 (April 24 2025)
31
- - Added pattern_id field based on filename for stable references
32
- - Modified HTML links to use Markdown-style [[Pattern Name]] format
33
- - Removed example sections from content as they're already extracted separately
34
- - Removed "\n" characters in examples for consistency with other sections
35
- - Standardized section names to snake_case for better consistency
36
- - Added metadata section with version, processing date, and source file information
37
 
38
 
39
  ### v1.1 (March 26 2025)
40
- - Added "playable" property to each entity
41
  - When playable concepts are available at "https://itch.io/c/3720943/goal-playable-concepts", the value points to the specific page
42
  - Otherwise, the value is "Not available yet"
43
- - Removed "\n" characters in "content", "Using the pattern" and "Consequences" properties for improved clarity and parsing
44
 
45
  ### v1.0 (March 11 2025)
46
- - Initial release of the structured JSON dataset
47
 
48
  ## License
49
  This dataset is released under the MIT License, allowing for both academic and commercial use with proper attribution.
 
5
 
6
  ## Original Source Attribution
7
  This dataset is derived from the work of Staffan Björk and Jussi Holopainen. The original content comes from "Patterns in Game Design," published by Charles River Media in 2005.
8
+ * Original authors: Jussi Kuittinen, Staffan Björk and Jussi Holopainen
9
+ * Original format: HTML documents publicly available at: https://www.researchgate.net/publication/379683418_collection.zip
10
+ * Citation: Bjork, S., & Holopainen, J. (2005). Patterns in game design (Vol. 11). Charles River Media Hingham.
11
 
12
  ## Dataset Preparation
13
  This dataset represents a cleaned and structured JSON version of the original HTML content, prepared to facilitate machine learning, knowledge graph applications, and other computational approaches to game design research.
14
 
15
  ## Dataset Curator
16
+ * Name: Liu, Hugh Xuechen
17
+ * Contact: https://hughxuechen.github.io/
18
+ * Affiliation: Chalmers Univeristy of Technology
19
 
20
  ## Version History
21
 
22
+ ### v1.2.2.1 (April 26 2025)
23
+ * Enhanced text processing to remove consecutive spaces in all text fields
24
+ * Improved example extraction by:
25
+ - Automatically capitalizing the first letter after removing "Example:" prefix
26
+ - Using regex to clean up all whitespace issues (newlines, tabs, multiple spaces)
27
+ * Applied consistent text cleaning using re.sub() instead of simple replace()
28
+ * Fixed issue where multiple consecutive spaces could appear in processed text
29
+ * Ensured uniform text formatting across all sections of the JSON output
30
+
31
  ### v1.2.2 (April 26 2025)
32
  - Pattern links in Example sections are now converted to [[Pattern]] format
33
 
34
  ### v1.2.1 (April 24 2025)
35
+ * Added functionality to export all pattern links to a CSV file
36
+ * The CSV includes source pattern, target pattern name, and target file name
37
 
38
 
39
  ### v1.2 (April 24 2025)
40
+ * Added pattern_id field based on filename for stable references
41
+ * Modified HTML links to use Markdown-style [[Pattern Name]] format
42
+ * Removed example sections from content as they're already extracted separately
43
+ * Removed "\n" characters in examples for consistency with other sections
44
+ * Standardized section names to snake_case for better consistency
45
+ * Added metadata section with version, processing date, and source file information
46
 
47
 
48
  ### v1.1 (March 26 2025)
49
+ * Added "playable" property to each entity
50
  - When playable concepts are available at "https://itch.io/c/3720943/goal-playable-concepts", the value points to the specific page
51
  - Otherwise, the value is "Not available yet"
52
+ * Removed "\n" characters in "content", "Using the pattern" and "Consequences" properties for improved clarity and parsing
53
 
54
  ### v1.0 (March 11 2025)
55
+ * Initial release of the structured JSON dataset
56
 
57
  ## License
58
  This dataset is released under the MIT License, allowing for both academic and commercial use with proper attribution.