Skip to content

Commit bf8fbb6

Browse files
committed
Updated README, changelog, version numbers, license years, links, nuspec
1 parent a02f33f commit bf8fbb6

File tree

7 files changed

+66
-39
lines changed

7 files changed

+66
-39
lines changed

README.md

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
fNbt is a small library, written in C# for .NET 3.5+. It provides functionality
55
to create, load, traverse, modify, and save NBT files and streams.
66

7-
Current released version is 0.6.3 (12 April 2015).
7+
Current released version is 0.6.4 (6 July 2018).
88

99
fNbt is based in part on Erik Davidson's (aphistic's) original LibNbt library,
1010
now completely rewritten by Matvei Stefarov (fragmer).
@@ -31,11 +31,15 @@ Latest version of fNbt requires .NET Framework 3.5+ (client or full profile).
3131

3232
- **Package @ NuGet:** https://www.nuget.org/packages/fNbt/
3333

34-
- **Compiled binary:** https://fcraft.net/fnbt/fNbt_v0.6.3.zip<br><sup>SHA1: c743b4e8af649af75d7ab097dfec2bc897a70689</sup>
34+
- **Compiled binary:** https://fcraft.net/fnbt/fNbt_v0.6.4.zip
35+
<br><sup>SHA1: 600853530fd538e614b6cb4722ced81917e9615d</sup>
3536

3637
- **Amalgamation** (single source file):
37-
* Non-annotated: https://fcraft.net/fnbt/fNbt_v0.6.3.cs<br><sup>SHA1: 2a2cd74bee0bab765d9647e0cc048927248d0142</sup>
38-
* Annotated (using [JetBrains.Annotations](https://blog.jetbrains.com/dotnet/2018/05/03/what-are-jetbrains-annotations/)): https://fcraft.net/fnbt/fNbt_v0.6.3_Annotated.cs<br><sup>SHA1: 66ab908708678272a58d9e71f1615f68caba79d7</sup>
38+
* Non-annotated: https://fcraft.net/fnbt/fNbt_v0.6.4.cs
39+
<br><sup>SHA1: 9298dbe00d080bcf5d32299415aaf856590ba3bf</sup>
40+
* Annotated (using [JetBrains.Annotations](https://blog.jetbrains.com/dotnet/2018/05/03/what-are-jetbrains-annotations/)):
41+
https://fcraft.net/fnbt/fNbt_v0.6.4_Annotated.cs
42+
<br><sup>SHA1: ae096d83b57bf59c708ad66168d45c1ea9b58175</sup>
3943

4044

4145
## EXAMPLES
@@ -70,11 +74,11 @@ Latest version of fNbt requires .NET Framework 3.5+ (client or full profile).
7074
foreach( string tagName in myCompoundTag.Names ){
7175
Console.WriteLine( tagName );
7276
}
73-
for( int i=0; i<myListTag.Count; i++ ){
77+
for( int i = 0; i < myListTag.Count; i++ ){
7478
Console.WriteLine( myListTag[i] );
7579
}
76-
foreach( NbtInt intListItem in myIntList.ToArray<NbtInt>() ){
77-
Console.WriteLine( listIntItem.Value );
80+
foreach( NbtInt intItem in myIntList.ToArray<NbtInt>() ){
81+
Console.WriteLine( intItem.Value );
7882
}
7983
```
8084

@@ -105,25 +109,25 @@ Latest version of fNbt requires .NET Framework 3.5+ (client or full profile).
105109

106110
#### Pretty-printing file structure
107111
```cs
108-
Console.WriteLine( myFile.ToString("\t") );
109-
Console.WriteLine( myRandomTag.ToString(" ") );
112+
Console.WriteLine( myFile.ToString("\t") ); // tabs
113+
Console.WriteLine( myRandomTag.ToString(" ") ); // spaces
110114
```
111115

112116
#### Check out unit tests in fNbt.Test for more examples.
113117

114118

115119
## API REFERENCE
116-
Online reference can be found at http://www.fcraft.net/fnbt/v0.6.3/
120+
Online reference can be found at http://www.fcraft.net/fnbt/v0.6.4/
117121

118122

119123
## LICENSING
120-
fNbt v0.5.0+ is licensed under 3-Clause BSD license. See ./docs/LICENSE
124+
fNbt v0.5.0+ is licensed under 3-Clause BSD license;
125+
see [docs/LICENSE](docs/LICENSE).
121126
LibNbt2012 up to and including v0.4.1 kept LibNbt's original license (LGPLv3).
122-
fNbt makes use of the NUnit testing framework (www.nunit.org)
123127

124128

125129
## VERSION HISTORY
126-
See ./docs/Changelog
130+
See [docs/Changelog.md](docs/Changelog.md)
127131

128132

129133
## OLD VERSIONS

docs/Changelog renamed to docs/Changelog.md

Lines changed: 24 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,29 @@
1-
0.6.3 (fNbt)
2-
- Empty NbtLists now allow "TAG_End" as its ListType.
1+
## 0.6.4 (fNbt)
2+
- Fixed a case where NbtBinaryReader.ReadString read too many bytes (#26).
3+
- Fixed NbtList.Contains(null) throwing exception instead of returning false.
4+
- Reduced NbtBinaryReader's maximum chunk size to 4 MB. This reduces peak
5+
memory use when reading huge files without affecting performance.
36

4-
0.6.2 (fNbt)
5-
- NbtTags now implement ICloneable and provide copy constructors.
7+
## 0.6.3 (fNbt)
8+
- Empty NbtLists now allow "TAG_End" as its ListType (#12).
9+
10+
## 0.6.2 (fNbt)
11+
- NbtTags now implement ICloneable and provide copy constructors (#10).
612
- fNbt is now compatible with /checked compiler option.
713
- Fixed an OverflowException in .NET 4.0+ when writing arrays of size 1 GiB
814
(or larger) to a BufferedStream.
915
- Fixed a few edge cases in NbtReader when reading corrupt files.
1016
- Minor optimizations and documentation fixes.
1117

12-
0.6.1 (fNbt)
18+
## 0.6.1 (fNbt)
1319
- NbtReader now supports non-seekable streams.
1420
- Fixed issues loading from/saving to non-seekable steams in NbtFile.
1521
- NbtFile.LoadFromStream/SaveToStream now accurately report bytes read/written
1622
for NBT data over 2 GiB in size.
1723
- API change:
1824
All NbtFile loading/saving methods now return long instead of int.
1925

20-
0.6.0 (fNbt)
26+
## 0.6.0 (fNbt)
2127
- Raised .NET framework requirements from 2.0+ to 3.5+
2228
- Added NbtWriter, for linearly writing NBT streams, similarly to XmlWriter.
2329
It enables high-performance writing, without creating temp NbtTag objects.
@@ -29,7 +35,7 @@
2935
- Improved tag reading and writing performance.
3036
- Expanded unit test coverage.
3137

32-
0.5.1 (fNbt)
38+
## 0.5.1 (fNbt)
3339
- Fixed ToString() methods of NbtReader and some NbtTags not respecting the
3440
NbtTag.DefaultIndentString setting.
3541
- Fixed being able to add a Compound tag to itself.
@@ -40,7 +46,7 @@
4046
New NbtReader overload: string ToString(bool,string)
4147
- Expanded unit test coverage.
4248

43-
0.5.0 (fNbt)
49+
## 0.5.0 (fNbt)
4450
- Added NbtReader, for linearly reading NBT streams, similarly to XmlReader.
4551
- API additions:
4652
New NbtCompound method: bool TryGet(string,out NbtTag)
@@ -49,7 +55,7 @@
4955
- License changed from LGPL to to 3-Clause BSD, since none of the original
5056
libnbt source code remains.
5157

52-
0.4.1 (LibNbt2012)
58+
## 0.4.1 (LibNbt2012)
5359
- Added a way to set up default indent for NbtTag.ToString() methods, using
5460
NbtTag.DefaultIndentString static property.
5561
- Added a way to control/disable buffering when reading tags, using properties
@@ -61,7 +67,7 @@
6167
- NbtFile() constructor now initializes RootTag to an empty NbtCompound("").
6268
- Added LoadFro* overloads that do not require a TagSelector parameter.
6369

64-
0.4.0 (LibNbt2012)
70+
## 0.4.0 (LibNbt2012)
6571
- Changed the way NbtFiles are constructed. Data is not loaded in the
6672
constructor itself any more, use LoadFrom* method.
6773
- Added a way to load NBT data directly from byte arrays, and to save them to
@@ -71,19 +77,19 @@
7177
- Updated NbtFile to override ToString.
7278
- Added a way to control endianness when reading/writing NBT files.
7379

74-
0.3.4 (LibNbt2012)
80+
## 0.3.4 (LibNbt2012)
7581
- Added a way to rename tags inside NbtCompound and NbtFile.
7682

77-
0.3.3 (LibNbt2012)
83+
## 0.3.3 (LibNbt2012)
7884
- Added a way to skip certain tags at load-time, using a TagSelector callback.
7985

80-
0.3.2 (LibNbt2012)
86+
## 0.3.2 (LibNbt2012)
8187
- Added a way to easily identify files, using static NbtFile.ReadRootTagName.
8288
- Added NbtTag.Parent (automatically set/reset by NbtList and NbtCompound).
8389
- Added NbtTag.Path (which includes parents' names, and list indices).
8490
- Added NbtCompound.Names and NbtCompound.Values enumerators.
8591

86-
0.3.1 (LibNbt2012)
92+
## 0.3.1 (LibNbt2012)
8793
- Added indexers to NbtTag base class, to make nested compound/list tags easier
8894
to work with.
8995
- Added shortcut properties for getting tag values.
@@ -92,7 +98,7 @@
9298
- Improved .ToString() pretty-printing, now with consistent and configurable
9399
indentation.
94100

95-
0.3.0 (LibNbt2012)
101+
## 0.3.0 (LibNbt2012)
96102
- Auto-detection of NBT file compression.
97103
- Loading and saving of ZLib (RFC-1950) compresessed NBT files.
98104
- Reduced loading/saving CPU use by 15%, and memory use by 40%
@@ -106,17 +112,17 @@
106112
- Made tag names immutable.
107113
- Removed tag queries.
108114

109-
0.2.0 (libnbt)
115+
## 0.2.0 (libnbt)
110116
- Implemented tag queries.
111117
- Created unit tests for the larger portions of the code.
112118
- Marked tag constructors that take only tag values as obsolete, use the
113119
constructor that has name and value instead.
114120

115-
0.1.2 (libnbt)
121+
## 0.1.2 (libnbt)
116122
- Added a GetTagType() function to the tag classes.
117123
- Fixed saving NbtList tags.
118124

119-
0.1.1 (libnbt)
125+
## 0.1.1 (libnbt)
120126
- Initial release.
121127
- Modified the tag constructors to be consistant with each other.
122128
- Changed NbtFile to allow some functions to be overridden.

docs/LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Copyright (c) 2012-2015, Matvei "fragmer" Stefarov <[email protected]>
1+
Copyright (c) 2012-2018, Matvei "fragmer" Stefarov <[email protected]>
22
All rights reserved.
33

44
Redistribution and use in source and binary forms, with or without

fNbt.Test/Properties/AssemblyInfo.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
[assembly: AssemblyConfiguration("")]
1111
[assembly: AssemblyCompany("github.com/fragmer/fNbt")]
1212
[assembly: AssemblyProduct("fNbt.Test")]
13-
[assembly: AssemblyCopyright("2012-2015 Matvei Stefarov")]
13+
[assembly: AssemblyCopyright("2012-2018 Matvei Stefarov")]
1414
[assembly: AssemblyTrademark("")]
1515
[assembly: AssemblyCulture("")]
1616

@@ -35,5 +35,5 @@
3535
// by using the '*' as shown below:
3636
// [assembly: AssemblyVersion("1.0.*")]
3737

38-
[assembly: AssemblyVersion("0.6.3.0")]
39-
[assembly: AssemblyFileVersion("0.6.3.0")]
38+
[assembly: AssemblyVersion("0.6.4.0")]
39+
[assembly: AssemblyFileVersion("0.6.4.0")]

fNbt.sln

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ VisualStudioVersion = 15.0.27703.2035
55
MinimumVisualStudioVersion = 10.0.40219.1
66
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "docs", "docs", "{83C41F58-F6F7-46F2-85C3-CDD69E7FBEE6}"
77
ProjectSection(SolutionItems) = preProject
8-
docs\Changelog = docs\Changelog
8+
docs\Changelog.md = docs\Changelog.md
99
docs\LICENSE = docs\LICENSE
1010
README.md = README.md
1111
EndProjectSection

fNbt/Properties/AssemblyInfo.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
[assembly: AssemblyConfiguration("")]
1212
[assembly: AssemblyCompany("github.com/fragmer/fNbt")]
1313
[assembly: AssemblyProduct("fNbt")]
14-
[assembly: AssemblyCopyright("2012-2015 Matvei Stefarov")]
14+
[assembly: AssemblyCopyright("2012-2018 Matvei Stefarov")]
1515
[assembly: AssemblyTrademark("")]
1616
[assembly: AssemblyCulture("")]
1717

@@ -36,8 +36,8 @@
3636
// by using the '*' as shown below:
3737
// [assembly: AssemblyVersion("1.0.*")]
3838

39-
[assembly: AssemblyVersion("0.6.3.0")]
40-
[assembly: AssemblyFileVersion("0.6.3.0")]
39+
[assembly: AssemblyVersion("0.6.4.0")]
40+
[assembly: AssemblyFileVersion("0.6.4.0")]
4141

4242
// Potentially speed up resource probes
4343

fNbt/fNbt.nuspec

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
<?xml version="1.0"?>
2+
<package >
3+
<metadata>
4+
<id>$id$</id>
5+
<version>$version$</version>
6+
<title>$title$</title>
7+
<authors>Erik Davidson (2010-2011); Matvei Stefarov (2012+)</authors>
8+
<owners>$author$</owners>
9+
<licenseUrl>https://github.com/fragmer/fNbt/blob/v0.6.4/docs/LICENSE</licenseUrl>
10+
<projectUrl>https://github.com/fragmer/fNbt</projectUrl>
11+
<requireLicenseAcceptance>false</requireLicenseAcceptance>
12+
<description>$description$</description>
13+
<releaseNotes>Bugfixes and performance improvements.</releaseNotes>
14+
<copyright>Copyright 2012-2018 Matvei Stefarov</copyright>
15+
<tags>nbt serialization</tags>
16+
</metadata>
17+
</package>

0 commit comments

Comments
 (0)