From b24082bc24910748cd7da8b9cad517261aa98476 Mon Sep 17 00:00:00 2001 From: Ray Koopa Date: Wed, 3 May 2017 15:46:44 +0200 Subject: [PATCH] Fixed XML summaries, added logo. --- res/Logo.png | Bin 0 -> 3874 bytes res/Logo.svg | 113 ++++++++++++++++++ src/NuGet.config | 6 - src/Syroot.Worms/Core/ByteExtensions.cs | 14 ++- src/Syroot.Worms/Core/Team17Compression.cs | 2 +- src/Syroot.Worms/Gen2/Armageddon/Team.cs | 8 +- src/Syroot.Worms/Gen2/Image.cs | 2 +- src/Syroot.Worms/Gen2/WorldParty/Team.cs | 8 +- src/Syroot.Worms/Gen2/Worms2/SchemeOptions.cs | 2 +- src/Syroot.Worms/Gen2/Worms2/SchemeWeapons.cs | 2 +- src/Syroot.Worms/{Bitmap.cs => ImageData.cs} | 2 +- src/Syroot.Worms/Syroot.Worms.csproj | 7 +- 12 files changed, 139 insertions(+), 27 deletions(-) create mode 100644 res/Logo.png create mode 100644 res/Logo.svg delete mode 100644 src/NuGet.config rename src/Syroot.Worms/{Bitmap.cs => ImageData.cs} (97%) diff --git a/res/Logo.png b/res/Logo.png new file mode 100644 index 0000000000000000000000000000000000000000..f5272dcf3db5168280c06ac02b3db9a571e2a36f GIT binary patch literal 3874 zcmV+-58d#IP)*L#1QbI(1w_nvdlJrQI8E|+VD5QY^X7a&Ci z$Z0@6pbmHOOK=KA4{%%}8-%jK#T z7`A|%uc!au;2^A6`7wgSf3`p*x4&hFj2IehqY0)aqE0~?J-7GJcOD_5?h;=GD@UHlSpgQ{9~ zq{KKyBvpX7*Sk2R$Pa+*NZqMZ-|)vxn>c#(NJfOHSy00-esMdKCr=*PG$aw%tE#0w zBLl_3m*J3i6k`CC^+{B}guEXaW+XJ3G`+OdI^f9ei zgi2La{YJ;UbR+HxaJl;DDk41jzWzRJHm$ujnX*~7bQ$&aJ7{ffrLVt_!-qd-YEcoY zO~vQ)F%%fW+3TdY_dB|}x@hlcr?s_}j*bppf;BZAqqDP_TTV_6e!rhkC^U-BU@)-i=2g_yT^T(OTy7U{@7hKEU+SZ-v0k{{ zE^UQEZb}SvAif_U<=M!m)e_$SilT7uz5l>VFaC+GTefle<(H2lyYr4ax#pT{HHV>U zQ@QD;pYr&>JRZ-}8x#Hg{UfU~?hC|MfKX0HJ|hR<(xuC|(mr`NhT40a#eGa8$q5t5-)S zboJHOBps~0yqrag7U>o)*J2qdZLe-(ortS|kO(zIzDr6Cwr<-xiud#x({&5yusgIBq0lMa#5$4iG9(1AM7}Rv zxDcPu$Idr*^7ihxdFP#Xcx2sL1_uYJsae3#&`^}_+xBnS_QE#0ySu5c-$6q|gNASJ zB>e|@X=$mZEQKMl|C}ZgDj-B?8-$HvZSBQ$cX!hnLqlf|=_b~RgbGkq^`wN40UQnoXMAUvI8hr7`|9hjh6OFf z>-7TQbZKpOM@PG++&A1W8754aKyh(#OpQ1?dGh2@c5%EIGaev>+#30wHm!(~k`hgO zUtb>p<>j+DdGaIxITI#m2N2pJ+-{F9!73}~X-%e(AL$}Y5o0RAYPG%~p%Y-if*Phw zDbQSVBaTX8K_RWJVYhY0j1mnGo2reRJDvJ0Syfe)R?v{xrHe2{Bv}E%FNAy&AS)}2 zU?@OE#W{CeQNqe_I2;`Q;xGU+XU^2{m^yW;rrg}ztV^)!s_NLHe;_chM;Bp=7*hcN z!C>$izzr~~d=_{+u@Rro$K=VAHBsINp$ZENDJUq2 zmL?eP3Xlv)g5TTQK++Weke{F52jYGR zo2N5p&a&>2b(*DaGMQ*?ZKe5mc#qdCsG+RvoE?`^vg@t4l8$A{GBK}mUTjsp-EP-s zI?{kH1pwG=x!ZsP05fLHpr@xt)1GC_0^pTbUXDw@ckdqBzD>UT=gyt0jV&s2lU^Cq zfo=r|AwmdwH{cgSAcUgv_|6W5LkM4f`6XX`@r8!g<#MuR>lR((R99>Ef2-AMeNV59 z=|Hyv0BknfApvUu^70&vQ1hF?j8R9Jo_YR*oD-ishgtaonryiGQM^BG$YGO|Mkg@`D)!c(XKR{Vo z8MohlM^Yusu9(eZk3PoBe|nh*?td_0Ka(jtHVR}IOFju#XBh+goKC0y7+V~qu?2+R zt{BWNpdK`-l z8=hiX(KG-~oH)UQzk49+NhZPt7hJ%@zh4{OS^~CORqNlUI){|cfLP?_=61W??zKp< z8p7FQ+qZAWl%37#)19=owkA!40Qj!wJEj#)NtpCIMq>~3Ya^wgN`y05p_F@1e z+~oCo*H|o;?^2n=xD)_j2pF=1hOoQd(b2)a5BH_a<6r;n35ur`(|o*nWP;R~c=gpk zQ@f-#vI??gKwb{Szm6tA%4TpR0){~J?i%McR~LLfA5G0oDNP=ry}g}d#~Pz$iCC8E z*yC1!l!oY2Pr3>i58iz*=C&*-PnCY$3gFy-0(9;7OylE^_s3WZS&}OKxD{X!G8*_F zN--vP%n%jnQ);%jtBcbUzrk6%Zkj z6-i>v9`P*p*Fx-Li$O6y?{;}z2-zb-ylGJ_yT2f2{*{R7rTmkYYNbZ(`H{EXUUphKE%!z0-a0mvYSsNqY^D~9z%m0RJ#z?{G>gr-> zXb6wTGs=Ayu+p4k-jIlP+*?3O`BmhKUr ziK7h`81vBMMNA${&Fsz?3OdsJo&r z2}N>LS5@=tU)`e#q0OtDhsl&Z29*|?R9h+Iny8E@z+$l+7w}@FylT}d%F9#sO2YyT zpZNFPcYo{?*;f#Le_Xh*CNc2{Oo@47M<{V)1)13bfG~(PKo^8#dk_D9Ew#0^NrRvf z7>!02FJ8+PEpR6<_>sruV}2zjZ^W{aC*m$5An zfz4)nUlOW9kUSY+G};6_6buE*V&R`Ch&zB3Zd~GnkW`i=nml|DDn`?iT85txt}I`4R*O)B?`*bQi{0<&I44Cxqv{@jgXxP kJ~0Fg^|^VuNi$3TA7|4OEUv#%m;e9(07*qoM6N<$f(mFi6#xJL literal 0 HcmV?d00001 diff --git a/res/Logo.svg b/res/Logo.svg new file mode 100644 index 0000000..74f7104 --- /dev/null +++ b/res/Logo.svg @@ -0,0 +1,113 @@ + + + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + diff --git a/src/NuGet.config b/src/NuGet.config deleted file mode 100644 index b1738fc..0000000 --- a/src/NuGet.config +++ /dev/null @@ -1,6 +0,0 @@ - - - - - - \ No newline at end of file diff --git a/src/Syroot.Worms/Core/ByteExtensions.cs b/src/Syroot.Worms/Core/ByteExtensions.cs index b57ef7c..8d6f4ca 100644 --- a/src/Syroot.Worms/Core/ByteExtensions.cs +++ b/src/Syroot.Worms/Core/ByteExtensions.cs @@ -1,3 +1,5 @@ +using System; + namespace Syroot.Worms.Core { /// @@ -121,7 +123,7 @@ namespace Syroot.Worms.Core /// The extended instance. /// The number of least significant bits which are used to store the /// value. - /// The first bit of the encoded value. + /// The first bit of the encoded value. /// The decoded . internal static byte DecodeByte(this byte self, int bits, int firstBit) { @@ -148,7 +150,7 @@ namespace Syroot.Worms.Core /// The extended instance. /// The number of least significant bits which are used to store the /// value. - /// The first bit of the encoded value. + /// The first bit of the encoded value. /// The decoded . internal static sbyte DecodeSByte(this byte self, int bits, int firstBit) { @@ -170,6 +172,7 @@ namespace Syroot.Worms.Core /// . /// /// The extended instance. + /// The value to encode. /// The number of bits which are used to store the value. /// The current byte with the value encoded into it. internal static byte Encode(this byte self, byte value, int bits) @@ -182,8 +185,9 @@ namespace Syroot.Worms.Core /// starting at . /// /// The extended instance. + /// The value to encode. /// The number of bits which are used to store the value. - /// The first bit used for the encoded value. + /// The first bit used for the encoded value. /// The current byte with the value encoded into it. internal static byte Encode(this byte self, byte value, int bits, int firstBit) { @@ -201,6 +205,7 @@ namespace Syroot.Worms.Core /// . /// /// The extended instance. + /// The value to encode. /// The number of bits which are used to store the value. /// The current byte with the value encoded into it. internal static byte Encode(this byte self, sbyte value, int bits) @@ -213,8 +218,9 @@ namespace Syroot.Worms.Core /// starting at . /// /// The extended instance. + /// The value to encode. /// The number of bits which are used to store the value. - /// The first bit used for the encoded value. + /// The first bit used for the encoded value. /// The current byte with the value encoded into it. internal static byte Encode(this byte self, sbyte value, int bits, int firstBit) { diff --git a/src/Syroot.Worms/Core/Team17Compression.cs b/src/Syroot.Worms/Core/Team17Compression.cs index db66aeb..08258d1 100644 --- a/src/Syroot.Worms/Core/Team17Compression.cs +++ b/src/Syroot.Worms/Core/Team17Compression.cs @@ -13,7 +13,7 @@ namespace Syroot.Worms.Core // ---- METHODS (INTERNAL) ------------------------------------------------------------------------------------- /// - /// Returns the data available in in compressed format. + /// Returns the data available in in compressed format. /// /// The data to compress. /// The compressed data. diff --git a/src/Syroot.Worms/Gen2/Armageddon/Team.cs b/src/Syroot.Worms/Gen2/Armageddon/Team.cs index fab4939..1a7e5ff 100644 --- a/src/Syroot.Worms/Gen2/Armageddon/Team.cs +++ b/src/Syroot.Worms/Gen2/Armageddon/Team.cs @@ -81,7 +81,7 @@ namespace Syroot.Worms.Gen2.Armageddon /// /// Gets or sets the team grave bitmap if it uses a custom one. /// - public Bitmap Grave { get; set; } + public ImageData Grave { get; set; } /// /// Gets or sets the team's special weapon. @@ -151,7 +151,7 @@ namespace Syroot.Worms.Gen2.Armageddon /// /// Gets or sets the bitmap of the team flag. /// - public Bitmap Flag { get; set; } + public ImageData Flag { get; set; } /// /// Gets or sets the deathmatch rank this team reached. @@ -210,7 +210,7 @@ namespace Syroot.Worms.Gen2.Armageddon if (GraveSprite < 0) { GraveFileName = reader.ReadFixedString(0x20); - Grave = new Bitmap() + Grave = new ImageData() { BitsPerPixel = 8, Size = new Vector2(24, 32), @@ -233,7 +233,7 @@ namespace Syroot.Worms.Gen2.Armageddon MissionStatuses = reader.ReadStructs(_missionCount); FlagFileName = reader.ReadFixedString(0x20); - Flag = new Bitmap() + Flag = new ImageData() { BitsPerPixel = 8, Size = new Vector2(20, 17), diff --git a/src/Syroot.Worms/Gen2/Image.cs b/src/Syroot.Worms/Gen2/Image.cs index 2c58b96..385eb97 100644 --- a/src/Syroot.Worms/Gen2/Image.cs +++ b/src/Syroot.Worms/Gen2/Image.cs @@ -11,7 +11,7 @@ namespace Syroot.Worms.Gen2 /// Represents a (palettized) graphical image stored in an IMG file, possibly compressed. /// Used by W2, WA and WWP. S. https://worms2d.info/Image_file. /// - public class Image : Bitmap, ILoadableFile, ISaveableFile + public class Image : ImageData, ILoadableFile, ISaveableFile { // ---- CONSTANTS ---------------------------------------------------------------------------------------------- diff --git a/src/Syroot.Worms/Gen2/WorldParty/Team.cs b/src/Syroot.Worms/Gen2/WorldParty/Team.cs index b7c040f..6e2df9f 100644 --- a/src/Syroot.Worms/Gen2/WorldParty/Team.cs +++ b/src/Syroot.Worms/Gen2/WorldParty/Team.cs @@ -79,7 +79,7 @@ namespace Syroot.Worms.Gen2.WorldParty /// /// Gets or sets the team grave bitmap if it uses a custom one. /// - public Bitmap Grave { get; set; } + public ImageData Grave { get; set; } /// /// Gets or sets the team's special weapon. @@ -149,7 +149,7 @@ namespace Syroot.Worms.Gen2.WorldParty /// /// Gets or sets the bitmap of the team flag. /// - public Bitmap Flag { get; set; } + public ImageData Flag { get; set; } /// /// Gets or sets an unknown value. @@ -209,7 +209,7 @@ namespace Syroot.Worms.Gen2.WorldParty if (GraveSprite < 0) { GraveFileName = reader.ReadFixedString(0x20); - Grave = new Bitmap() + Grave = new ImageData() { BitsPerPixel = 8, Size = new Vector2(24, 32), @@ -232,7 +232,7 @@ namespace Syroot.Worms.Gen2.WorldParty MissionStatuses = reader.ReadStructs(_missionCount); FlagFileName = reader.ReadFixedString(0x20); - Flag = new Bitmap() + Flag = new ImageData() { BitsPerPixel = 8, Size = new Vector2(20, 17), diff --git a/src/Syroot.Worms/Gen2/Worms2/SchemeOptions.cs b/src/Syroot.Worms/Gen2/Worms2/SchemeOptions.cs index 44e3df2..d56fe03 100644 --- a/src/Syroot.Worms/Gen2/Worms2/SchemeOptions.cs +++ b/src/Syroot.Worms/Gen2/Worms2/SchemeOptions.cs @@ -282,7 +282,7 @@ namespace Syroot.Worms.Gen2.Worms2 } /// - /// Saves the data into the given with the specified . + /// Saves the data into the given . /// /// The to save the data to. public void Save(Stream stream) diff --git a/src/Syroot.Worms/Gen2/Worms2/SchemeWeapons.cs b/src/Syroot.Worms/Gen2/Worms2/SchemeWeapons.cs index 3319619..34fd79d 100644 --- a/src/Syroot.Worms/Gen2/Worms2/SchemeWeapons.cs +++ b/src/Syroot.Worms/Gen2/Worms2/SchemeWeapons.cs @@ -93,7 +93,7 @@ namespace Syroot.Worms.Gen2.Worms2 } /// - /// Saves the data into the given with the specified . + /// Saves the data into the given . /// /// The to save the data to. public void Save(Stream stream) diff --git a/src/Syroot.Worms/Bitmap.cs b/src/Syroot.Worms/ImageData.cs similarity index 97% rename from src/Syroot.Worms/Bitmap.cs rename to src/Syroot.Worms/ImageData.cs index 3e2a22b..4b262ff 100644 --- a/src/Syroot.Worms/Bitmap.cs +++ b/src/Syroot.Worms/ImageData.cs @@ -5,7 +5,7 @@ namespace Syroot.Worms /// /// Represents a pixel-based 2D image in different color formats. /// - public class Bitmap + public class ImageData { // ---- PROPERTIES --------------------------------------------------------------------------------------------- diff --git a/src/Syroot.Worms/Syroot.Worms.csproj b/src/Syroot.Worms/Syroot.Worms.csproj index c9c92a4..16a8601 100644 --- a/src/Syroot.Worms/Syroot.Worms.csproj +++ b/src/Syroot.Worms/Syroot.Worms.csproj @@ -6,11 +6,11 @@ Syroot.Worms Worms Syroot - 0.1.0 + 1.0.0-alpha1 Syroot.Worms worms;team17 - Initial alpha release. + Initial release. https://raw.githubusercontent.com/Syroot/Worms/master/res/Logo.png https://github.com/Syroot/Worms https://raw.githubusercontent.com/Syroot/Worms/master/LICENSE @@ -21,12 +21,11 @@ - - +